1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250
|
# localslackirc
# Copyright (C) 2018-2025 Salvo "LtWorf" Tomaselli
#
# localslackirc is free software: you can redistribute it and/or modify
# it under the terms of the GNU 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
# author Salvo "LtWorf" Tomaselli <tiposchi@tiscali.it>
import asyncio
import datetime
from enum import Enum
from pathlib import Path
import re
import signal
import socket
import argparse
from typing import NamedTuple, Iterable
import os
from os import environ
from os.path import expanduser
import pwd
from socket import gethostname
import sys
import time
import slack
from log import *
import msgparsing
from diff import seddiff
VERSION = '1.36'
class IrcDisconnectError(Exception): ...
class Replies(Enum):
RPL_LUSERCLIENT = 251
RPL_AWAY = 301
RPL_USERHOST = 302
RPL_ISON = 303
RPL_UNAWAY = 305
RPL_NOWAWAY = 306
RPL_WHOISUSER = 311
RPL_WHOISSERVER = 312
RPL_WHOISOPERATOR = 313
RPL_ENDOFWHO = 315
RPL_WHOISIDLE = 317
RPL_ENDOFWHOIS = 318
RPL_WHOISCHANNELS = 319
RPL_LIST = 322
RPL_LISTEND = 323
RPL_CHANNELMODEIS = 324
RPL_TOPIC = 332
RPL_WHOREPLY = 352
RPL_NAMREPLY = 353
RPL_ENDOFNAMES = 366
ERR_NOSUCHNICK = 401
ERR_NOSUCHCHANNEL = 403
ERR_CANNOTSENDTOCHAN = 404
ERR_UNKNOWNCOMMAND = 421
ERR_FILEERROR = 424
ERR_ERRONEUSNICKNAME = 432
ERR_NEEDMOREPARAMS = 461
class Provider(Enum):
SLACK = 0
#: Inactivity days to hide a MPIM
MPIM_HIDE_DELAY = datetime.timedelta(days=10)
class ClientSettings(NamedTuple):
nouserlist: bool
autojoin: bool
no_rejoin_on_mention: bool
provider: Provider
ignored_channels: set[bytes]
silenced_yellers: set[bytes]
downloads_directory: Path
formatted_max_lines: int = 0
def verify(self) -> str | None:
'''
Make sure that the configuration is correct.
In that case return None. Otherwise an error string.
'''
if not self.downloads_directory.exists():
try:
self.downloads_directory.mkdir(parents=True)
except Exception:
return f'Unable to create {self.downloads_directory}'
elif not self.downloads_directory.is_dir():
return f'{self.downloads_directory} is not a directory'
if self.formatted_max_lines and not os.access(self.downloads_directory, os.W_OK | os.R_OK | os.X_OK):
return f'Insufficient permissions on downloads directory: {self.downloads_directory}'
return None
class Client:
def __init__(
self,
s: asyncio.streams.StreamWriter,
sl_client: slack.Slack,
settings: ClientSettings,
):
self.nick = b''
self.username = b''
self.realname = b''
self.parted_channels: set[bytes] = settings.ignored_channels
self.known_threads: dict[bytes, slack.MessageThread] = {}
self.hostname = gethostname().encode('utf8')
self.settings = settings
self.s = s
self.sl_client = sl_client
self._usersent = False # Used to hold all events until the IRC client sends the initial USER message
self._held_events: list[slack.SlackEvent] = []
self._mentions_regex_cache: dict[str, re.Pattern | None] = {} # Cache for the regexp to perform mentions. Key is channel id
def get_mention_str(self) -> str:
'''
Returns the string that is present in messages when the user is getting mentioned
'''
return f'<@{self.sl_client.login_info.self.id if self.sl_client.login_info else ""}>'
async def _nickhandler(self, cmd: bytes) -> None:
if b' ' not in cmd:
self.nick = b'localslackirc'
else:
_, nick = cmd.split(b' ', 1)
self.nick = nick.strip()
assert self.sl_client.login_info
if self.nick != self.sl_client.login_info.self.name.encode('ascii'):
await self._sendreply(Replies.ERR_ERRONEUSNICKNAME, 'Incorrect nickname, use %s' % self.sl_client.login_info.self.name)
async def _sendreply(self, code: int|Replies, message: str|bytes, extratokens: Iterable[str|bytes] = []) -> None:
codeint = code if isinstance(code, int) else code.value
bytemsg = message if isinstance(message, bytes) else message.encode('utf8')
extratokens = list(extratokens)
extratokens.insert(0, self.nick)
self.s.write(b':%s %03d %s :%s\r\n' % (
self.hostname,
codeint,
b' '.join(i if isinstance(i, bytes) else i.encode('utf8') for i in extratokens),
bytemsg,
))
await self.s.drain()
async def _userhandler(self, cmd: bytes) -> None:
#TODO USER salvo 8 * :Salvatore Tomaselli
assert self.sl_client.login_info
await self._sendreply(1, 'Welcome to localslackirc')
await self._sendreply(2, 'Your team name is: %s' % self.sl_client.login_info.team.name)
await self._sendreply(2, 'Your team domain is: %s' % self.sl_client.login_info.team.domain)
await self._sendreply(2, 'Your nickname must be: %s' % self.sl_client.login_info.self.name)
await self._sendreply(2, f'Version: {VERSION}')
await self._sendreply(Replies.RPL_LUSERCLIENT, 'There are 1 users and 0 services on 1 server')
await self._sendreply(2, '============= Extra IRC commands supported =============')
await self._sendreply(2, '/annoy')
await self._sendreply(2, '/dropannoy')
await self._sendreply(2, '/listannoy')
await self._sendreply(2, '/autoreact')
await self._sendreply(2, '/dropautoreact')
await self._sendreply(2, '/listautoreact')
await self._sendreply(2, '/sendfile')
if self.settings.autojoin and not self.settings.nouserlist:
# We're about to load many users for each chan; instead of requesting each
# profile on its own, batch load the full directory.
await self.sl_client.prefetch_users()
if self.settings.autojoin:
mpim_cutoff = datetime.datetime.utcnow() - MPIM_HIDE_DELAY
for sl_chan in await self.sl_client.joined_channels():
if not sl_chan.is_member:
continue
if sl_chan.is_mpim and ((sl_chan.updated / 1000) < mpim_cutoff.timestamp()):
continue
channel_name = '#%s' % sl_chan.name_normalized
channel_name_b = channel_name.encode('ascii')
if channel_name_b in self.parted_channels:
log(f'Not joining {channel_name} on IRC, marked as parted')
continue
await self._send_chan_info(channel_name_b, sl_chan)
else:
for sl_chan in await self.sl_client.joined_channels():
channel_name = '#%s' % sl_chan.name_normalized
self.parted_channels.add(channel_name.encode('utf-8'))
# Eventual channel joining done, sending the held events
self._usersent = True
for ev in self._held_events:
await self.slack_event(ev)
self._held_events = []
async def _pinghandler(self, cmd: bytes) -> None:
_, lbl = cmd.split(b' ', 1)
self.s.write(b':%s PONG %s %s\r\n' % (self.hostname, self.hostname, lbl))
await self.s.drain()
async def _joinhandler(self, cmd: bytes) -> None:
_, channel_names_b = cmd.split(b' ', 1)
for channel_name_b in channel_names_b.split(b','):
if channel_name_b in self.parted_channels:
self.parted_channels.remove(channel_name_b)
channel_name = channel_name_b[1:].decode()
try:
slchan = await self.sl_client.get_channel_by_name(channel_name)
except Exception:
await self._sendreply(Replies.ERR_NOSUCHCHANNEL, f'Unable to find channel: {channel_name}')
continue
if not slchan.is_member:
try:
await self.sl_client.join(slchan)
except Exception:
await self._sendreply(Replies.ERR_NOSUCHCHANNEL, f'Unable to join server channel: {channel_name}')
try:
await self._send_chan_info(channel_name_b, slchan)
except Exception:
await self._sendreply(Replies.ERR_NOSUCHCHANNEL, f'Unable to join channel: {channel_name}')
async def _send_chan_info(self, channel_name: bytes, slchan: slack.Channel|slack.MessageThread):
if not self.settings.nouserlist:
l = await self.sl_client.get_members(slchan.id)
userlist: list[bytes] = []
for i in l:
try:
u = await self.sl_client.get_user(i)
except Exception:
continue
if u.deleted:
# Disabled user, skip it
continue
name = u.name.encode('utf8')
prefix = b''
if u.is_admin:
prefix = b'@'
elif u.is_bot:
prefix = b'+'
userlist.append(prefix + name)
users = b' '.join(userlist)
try:
yelldest = b'#' + (await self.sl_client.get_channel(slchan.id)).name.encode('utf8')
except KeyError:
yelldest = b''
topic = (await self.parse_message(slchan.real_topic, b'', yelldest)).replace('\n', ' | ')
self.s.write(b':%s!%s@127.0.0.1 JOIN %s\r\n' % (self.nick, self.nick, channel_name))
await self.s.drain()
await self._sendreply(Replies.RPL_TOPIC, topic, [channel_name])
await self._sendreply(Replies.RPL_NAMREPLY, b'' if self.settings.nouserlist else users, ['=', channel_name])
await self._sendreply(Replies.RPL_ENDOFNAMES, 'End of NAMES list', [channel_name])
async def _privmsghandler(self, cmd: bytes) -> None:
_, dest, msg = cmd.split(b' ', 2)
if msg.startswith(b':'):
msg = msg[1:]
# Handle sending "/me does something"
# b'PRIVMSG #much_private :\x01ACTION saluta tutti\x01'
if msg.startswith(b'\x01ACTION ') and msg.endswith(b'\x01'):
action = True
_, msg = msg.split(b' ', 1)
msg = msg[:-1]
else:
action = False
await self.send_slack_message(dest, msg, action, False)
async def send_slack_message(self, dest: bytes, msg: bytes, action: bool, re_send_to_irc: bool) -> None:
if dest in self.known_threads:
dest_object: slack.User|slack.Channel|slack.MessageThread = self.known_threads[dest]
elif dest.startswith(b'#'):
try:
dest_object = await self.sl_client.get_channel_by_name(dest[1:].decode())
except KeyError:
await self._sendreply(Replies.ERR_NOSUCHCHANNEL, f'Unknown channel {dest.decode()}')
return
else:
try:
dest_object = await self.sl_client.get_user_by_name(dest.decode())
except KeyError:
await self._sendreply(Replies.ERR_NOSUCHNICK, f'Unknown user {dest.decode()}')
return
message = await self._addmagic(msg.decode('utf8'), dest_object)
try:
if isinstance(dest_object, slack.User):
await self.sl_client.send_message_to_user(
dest_object,
message,
action,
re_send_to_irc,
)
else:
await self.sl_client.send_message(
dest_object,
message,
action,
re_send_to_irc
)
except Exception as e:
await self._sendreply(Replies.ERR_CANNOTSENDTOCHAN, f'Message sending failed: {e}')
async def _listhandler(self, cmd: bytes) -> None:
for c in await self.sl_client.channels(refresh=True):
topic = (await self.parse_message(c.real_topic, b'', b'')).replace('\n', ' | ')
await self._sendreply(Replies.RPL_LIST, topic, ['#' + c.name, str(c.num_members)])
await self._sendreply(Replies.RPL_LISTEND, 'End of LIST')
async def _modehandler(self, cmd: bytes) -> None:
params = cmd.split(b' ', 2)
await self._sendreply(Replies.RPL_CHANNELMODEIS, '', [params[1], '+'])
async def _autoreacthandler(self, cmd: bytes) -> None:
params = cmd.split(b' ')
params.pop(0)
try:
username = params.pop(0).decode('utf8')
probability = float(params.pop(0))
if params:
reaction = msgparsing.get_emoji_code(params.pop(0).decode('utf8'))
else:
reaction = 'thumbsup'
if params:
duration = int(params.pop(0))
else:
duration = 10
if duration < 1 and duration != -1:
raise ValueError('Duration must be >0 or = -1')
# async def add_autoreact(self, username: str, reaction: str, probability: float, expiration: int) -> None:
await self.sl_client.add_autoreact(username, reaction, probability, time.time() + duration * 60 if duration != -1 else -1)
except Exception as e:
await self._sendreply(Replies.ERR_UNKNOWNCOMMAND, 'Syntax: /autoreact user probability [reaction] [duration]')
await self._sendreply(Replies.ERR_UNKNOWNCOMMAND, f'error: {e}')
return
await self._sendreply(0, f'Will react to {username} for {duration} minutes')
async def _annoyhandler(self, cmd: bytes) -> None:
params = cmd.split(b' ')
params.pop(0)
try:
user = params.pop(0).decode('utf8')
if params:
duration = int(params.pop())
else:
duration = 10 # 10 minutes default
if duration < 1 and duration != -1:
raise ValueError("Duration must be positive or -1")
await self.sl_client.add_annoy(user, time.time() + (duration * 60) if duration > 0 else duration)
except KeyError:
await self._sendreply(Replies.ERR_NOSUCHCHANNEL, f'Unable to find user: {user}')
return
except Exception:
await self._sendreply(Replies.ERR_UNKNOWNCOMMAND, 'Syntax: /annoy user [duration]')
return
await self._sendreply(0, f'Will annoy {user} for {duration} minutes')
async def _dropannoyhandler(self, cmd: bytes) -> None:
try:
user = cmd.split(b' ', 1)[1].decode('utf8')
await self.sl_client.drop_annoy(user)
except KeyError:
await self._sendreply(Replies.ERR_NOSUCHCHANNEL, f'Unable to find user: {user}')
return
except Exception:
await self._sendreply(Replies.ERR_UNKNOWNCOMMAND, 'Syntax: /dropannoy user')
return
await self._sendreply(0, f'No longer annoying {user}')
async def _dropautoreacthandler(self, cmd: bytes) -> None:
try:
user = cmd.split(b' ', 1)[1].decode('utf8')
await self.sl_client.drop_autoreact(user)
except KeyError:
await self._sendreply(Replies.ERR_NOSUCHCHANNEL, f'Unable to find user: {user}')
return
except Exception:
await self._sendreply(Replies.ERR_UNKNOWNCOMMAND, 'Syntax: /dropautoreact user')
return
await self._sendreply(0, f'No longer reacting to {user}')
async def _listannoyhandler(self, _: bytes) -> None:
for i in await self.sl_client.get_annoy():
await self._sendreply(0, f'Annoying {i}')
async def _listautoreacthandler(self, _: bytes) -> None:
for k, v in (await self.sl_client.get_autoreact()).items():
await self._sendreply(0, f'Reactions for {k}')
for i in v:
await self._sendreply(0, str(i))
async def _sendfilehandler(self, cmd: bytes) -> None:
#/sendfile #destination filename
try:
params = cmd.split(b' ', 2)
filename = params[2].decode('utf8')
except IndexError:
await self._sendreply(Replies.ERR_UNKNOWNCOMMAND, 'Syntax: /sendfile #channel filename')
return
try:
with open(filename, 'rb') as f:
content = f.read()
await self.send_file(params[1], content=content, filename=filename)
except Exception as e:
await self._sendreply(Replies.ERR_FILEERROR, f'Error: {e}')
async def send_file(self, bchannel_name: bytes, content: bytes, filename: str) -> bool:
channel_name = bchannel_name.decode('utf8')
if bchannel_name in self.known_threads:
dest_channel = self.known_threads[bchannel_name]
dest = dest_channel.id
thread_ts = dest_channel.thread_ts
else:
thread_ts = None
try:
if channel_name.startswith('#'):
dest = (await self.sl_client.get_channel_by_name(channel_name[1:])).id
else:
dest = (await self.sl_client.get_user_by_name(channel_name)).id
except KeyError:
await self._sendreply(Replies.ERR_NOSUCHCHANNEL, f'Unable to find destination: {channel_name}')
return False
try:
await self.sl_client.send_file(dest, content=content, filename=filename, thread_ts=thread_ts)
await self._sendreply(0, 'Upload completed')
return True
except Exception as e:
await self._sendreply(Replies.ERR_FILEERROR, f'Unable to send file {e}')
return False
async def _parthandler(self, cmd: bytes) -> None:
name = cmd.split(b' ')[1]
self.parted_channels.add(name)
if name in self.known_threads:
del self.known_threads[name]
async def _awayhandler(self, cmd: bytes) -> None:
is_away = b' ' in cmd
await self.sl_client.away(is_away)
response = Replies.RPL_NOWAWAY if is_away else Replies.RPL_UNAWAY
await self._sendreply(response, 'Away status changed')
async def _topichandler(self, cmd: bytes) -> None:
try:
_, channel_b, topic_b = cmd.split(b' ', 2)
channel_name = channel_b.decode()[1:]
topic = topic_b.decode()[1:]
except Exception as e:
await self._sendreply(Replies.ERR_UNKNOWNCOMMAND, 'Error: %s' % e)
return
try:
channel = await self.sl_client.get_channel_by_name(channel_name)
except KeyError:
await self._sendreply(Replies.ERR_NOSUCHCHANNEL, f'Unknown channel: {channel_name}')
return
try:
await self.sl_client.topic(channel, topic)
except Exception:
await self._sendreply(Replies.ERR_UNKNOWNCOMMAND, f'Unable to set topic to {topic}')
async def _caphandler(self, cmd: bytes) -> None:
# Do absolutely nothing
# support for capabilities is not implemented
# so we just ignore it
return
async def _isonhandler(self, cmd: bytes) -> None:
users = cmd.split(b' ')
del users[0]
r = []
if len(users) < 1:
await self._sendreply(Replies.ERR_NEEDMOREPARAMS, 'Syntax: /ison nickname')
return
for username in users:
if b'*' in username:
await self._sendreply(Replies.ERR_UNKNOWNCOMMAND, 'Wildcards are not supported')
continue
uusername = username.decode()
try:
user = await self.sl_client.get_user_by_name(uusername)
except KeyError:
continue
if not await self.sl_client.isAway(user):
r.append(username)
await self._sendreply(
Replies.RPL_ISON,
b' '.join(r),
)
async def _whoishandler(self, cmd: bytes) -> None:
users = cmd.split(b' ')
del users[0]
if len(users) != 1:
await self._sendreply(Replies.ERR_UNKNOWNCOMMAND, 'Syntax: /whois nickname')
return
# Seems that oftc only responds to the last one
username = users.pop()
if b'*' in username:
await self._sendreply(Replies.ERR_UNKNOWNCOMMAND, 'Wildcards are not supported')
return
uusername = username.decode()
try:
user = await self.sl_client.get_user_by_name(uusername)
except KeyError:
await self._sendreply(Replies.ERR_NOSUCHNICK, f'Unknown user {uusername}')
return
await self._sendreply(Replies.RPL_WHOISUSER, user.real_name, [username, '', 'localhost'])
if user.profile.email:
await self._sendreply(Replies.RPL_WHOISUSER, f'email: {user.profile.email}', [username, '', 'localhost'])
if user.is_admin:
await self._sendreply(Replies.RPL_WHOISOPERATOR, f'{uusername} is an admin', [username])
if user.is_bot:
await self._sendreply(Replies.RPL_WHOISUSER, f'{uusername} is a bot', [username])
if await self.sl_client.isAway(user):
await self._sendreply(Replies.RPL_AWAY, f'{uusername} is away', extratokens=[username])
await self._sendreply(Replies.RPL_ENDOFWHOIS, '', extratokens=[username])
async def _kickhandler(self, cmd: bytes) -> None:
try:
_, channel_b, username_b, message = cmd.split(b' ', 3)
channel_name = channel_b.decode()[1:]
username = username_b.decode()
except Exception as e:
await self._sendreply(Replies.ERR_UNKNOWNCOMMAND, 'Error: %s' % e)
return
try:
channel = await self.sl_client.get_channel_by_name(channel_name)
except KeyError:
await self._sendreply(Replies.ERR_NOSUCHCHANNEL, f'Unknown channel: {channel_name}')
return
try:
user = await self.sl_client.get_user_by_name(username)
except KeyError:
await self._sendreply(Replies.ERR_NOSUCHNICK, f'Unknown user: {username}')
return
try:
await self.sl_client.kick(channel, user)
except Exception as e:
await self._sendreply(Replies.ERR_UNKNOWNCOMMAND, 'Error: %s' % e)
async def _quithandler(self, cmd: bytes) -> None:
raise IrcDisconnectError()
async def _userhosthandler(self, cmd: bytes) -> None:
nicknames = cmd.split(b' ')
del nicknames[0] # Remove the command itself
#TODO replace + with - in case of away
#TODO append a * to the nickname for OP
replies = (b'%s=+unknown' % i for i in nicknames)
await self._sendreply(Replies.RPL_USERHOST, '', replies)
async def _invitehandler(self, cmd: bytes) -> None:
try:
_, username_b, channel_b = cmd.split(b' ', 2)
username = username_b.decode()
channel_name = channel_b.decode()[1:]
except Exception as e:
await self._sendreply(Replies.ERR_UNKNOWNCOMMAND, 'Error: %s' % e)
return
try:
channel = await self.sl_client.get_channel_by_name(channel_name)
except KeyError:
await self._sendreply(Replies.ERR_NOSUCHCHANNEL, f'Unknown channel: {channel_name}')
return
try:
user = await self.sl_client.get_user_by_name(username)
except KeyError:
await self._sendreply(Replies.ERR_NOSUCHNICK, f'Unknown user: {username}')
return
try:
await self.sl_client.invite(channel, user)
except Exception as e:
await self._sendreply(Replies.ERR_UNKNOWNCOMMAND, 'Error: %s' % e)
async def _whohandler(self, cmd: bytes) -> None:
_, name = cmd.split(b' ', 1)
if not name.startswith(b'#'):
try:
user = await self.sl_client.get_user_by_name(name.decode())
except KeyError:
return
await self._sendreply(Replies.RPL_WHOREPLY, '0 %s' % user.real_name, [name, user.name, '127.0.0.1', self.hostname, user.name, 'H'])
return
try:
channel = await self.sl_client.get_channel_by_name(name.decode()[1:])
except KeyError:
return
await self._sendreply(Replies.RPL_ENDOFWHO, 'End of WHO list', [name])
async def sendmsg(self, from_: bytes, to: bytes, message: bytes) -> None:
self.s.write(b':%s!%s@127.0.0.1 PRIVMSG %s :%s\r\n' % (
from_,
from_,
to, #private message, or a channel
message,
))
await self.s.drain()
async def _get_regexp(self, dest: slack.User|slack.Channel) -> re.Pattern | None:
#del self._mentions_regex_cache[sl_ev.channel]
# No nick substitutions for private chats
if isinstance(dest, slack.User):
return None
dest_id = dest.id
# Return from cache
if dest_id in self._mentions_regex_cache:
return self._mentions_regex_cache[dest_id]
usernames = []
for j in await self.sl_client.get_members(dest):
u = await self.sl_client.get_user(j)
usernames.append(u.name)
if len(usernames) == 0:
self._mentions_regex_cache[dest_id] = None
return None
# Extremely inefficient code to generate mentions
# Just doing them client-side on the receiving end is too mainstream
regexs = (r'((://\S*){0,1}\b%s\b)' % username for username in usernames)
regex = re.compile('|'.join(regexs))
self._mentions_regex_cache[dest_id] = regex
return regex
async def _addmagic(self, msg: str, dest: slack.User|slack.Channel) -> str:
"""
Adds magic codes and various things to
outgoing messages
"""
for i in msgparsing.SLACK_SUBSTITUTIONS:
msg = msg.replace(i[1], i[0])
if self.settings.provider == Provider.SLACK:
msg = msg.replace('@here', '<!here>')
msg = msg.replace('@channel', '<!channel>')
msg = msg.replace('@everyone', '<!everyone>')
regex = await self._get_regexp(dest)
if regex is None:
return msg
matches = list(re.finditer(regex, msg))
matches.reverse() # I want to replace from end to start or the positions get broken
for m in matches:
username = m.string[m.start():m.end()]
if username.startswith('://'):
continue # Match inside a url
elif self.settings.provider == Provider.SLACK:
msg = msg[0:m.start()] + '<@%s>' % (await self.sl_client.get_user_by_name(username)).id + msg[m.end():]
return msg
async def parse_message(self, i: str, source: bytes, destination: bytes) -> str:
"""
This converts a slack message into a message for IRC.
It will replace mentions and shouts with the IRC equivalent.
It will save preformatted text into txt files and link them
if the settings are such.
It will put the links at the end like with emails.
"""
r = ''
# Url replacing
links = ''
refs = str.maketrans("0123456789", "⁰¹²³⁴⁵⁶⁷⁸⁹")
refn = 1
for t in msgparsing.tokenize(i):
if isinstance(t, str): # A normal nice string
r += t
elif isinstance(t, msgparsing.PreBlock): # Preformatted block
# Store long formatted text into txt files
if self.settings.formatted_max_lines and t.lines > self.settings.formatted_max_lines:
import tempfile
with tempfile.NamedTemporaryFile(
mode='wt',
dir=self.settings.downloads_directory,
suffix='.txt',
prefix='localslackirc-attachment-',
delete=False) as tmpfile:
tmpfile.write(t.txt)
r += f'\n === PREFORMATTED TEXT AT file://{tmpfile.name}\n'
else: # Do not store to file
r += f'```{t.txt}```'
elif isinstance(t, msgparsing.SpecialItem):
if t.kind == msgparsing.Itemkind.MENTION: # User mention
r += (await self.sl_client.get_user(t.val)).name
elif t.kind == msgparsing.Itemkind.CHANNEL: # Channel mention
try:
r += '#' + (await self.sl_client.get_channel(t.val)).name_normalized
except KeyError:
# Slack might decide to send id of channels that do not exist, yes…
r += '#ERROR_MISSING_CHANNEL'
elif t.kind == msgparsing.Itemkind.YELL: # Channel shouting
if (source not in self.settings.silenced_yellers) and (destination not in self.settings.silenced_yellers):
yell = ' [%s]:' % self.nick.decode('utf8')
else:
yell = ':'
if t.val == 'here':
r += 'yelling' + yell
elif t.val == 'channel':
r += 'YELLING LOUDER' + yell
else:
r += 'DEAFENING YELL' + yell
else: # Link
label = t.human
if label is None:
r += t.val
else:
if '://' in label:
label = 'LINK'
ref = str(refn).translate(refs)
links += f'\n {ref} {t.val}'
r += label + ref
refn += 1
return r + links
async def _messageedit(self, sl_ev: slack.MessageEdit) -> None:
if not sl_ev.is_changed:
return
try:
yelldest = b'#' + (await self.sl_client.get_channel(sl_ev.channel)).name.encode('utf8')
except KeyError:
yelldest = b''
source = (await self.sl_client.get_user(sl_ev.previous.user)).name.encode('utf8')
previous = await self.parse_message(sl_ev.previous.text, source, yelldest)
current = await self.parse_message(sl_ev.current.text, source, yelldest)
diffmsg = slack.Message(
text=seddiff(sl_ev.previous.text, sl_ev.current.text),
channel=sl_ev.channel,
user=sl_ev.previous.user,
thread_ts=sl_ev.previous.thread_ts,
ts=sl_ev.previous.ts,
)
await self._message(diffmsg)
async def _message(self, sl_ev: slack.Message|slack.MessageDelete|slack.MessageBot|slack.ActionMessage, prefix: str=''):
"""
Sends a message to the irc client
"""
if not isinstance(sl_ev, slack.MessageBot):
source = (await self.sl_client.get_user(sl_ev.user)).name.encode('utf8')
else:
source = b'bot'
try:
yelldest = dest = b'#' + (await self.sl_client.get_channel(sl_ev.channel)).name.encode('utf8')
except KeyError:
dest = self.nick
yelldest = b''
except Exception as e:
error('Error: ', str(e))
return
text = sl_ev.text
mentioned = (not self.settings.no_rejoin_on_mention) and self.get_mention_str() in text
if sl_ev.thread_ts:
# Threaded message, rewriting the dest
thread = await self.sl_client.get_thread(sl_ev.thread_ts, sl_ev.channel)
original_dest = dest
dest = b'#' + thread.name.encode('utf8')
if dest in self.parted_channels:
if mentioned:
self.parted_channels.remove(dest)
else:
# This thread is being ignored
return
# Join thread channel if needed
if dest not in self.known_threads:
if original_dest in self.parted_channels and not mentioned:
# Ignoring new threads from a parted channel
# but keeping the known ones active
return
await self._send_chan_info(dest, self.known_threads.get(dest, thread))
self.known_threads[dest] = self.known_threads.get(dest, thread)
elif dest in self.parted_channels:
if mentioned:
# rejoin channel
slchan = await self.sl_client.get_channel(sl_ev.channel)
await self._send_chan_info(dest, slchan)
else:
# Ignoring messages, channel was left on IRC
# This ignores also threads on those channels
return
if sl_ev.files:
for f in sl_ev.files:
text+=f'\n[file upload] {f.name}\n{f.mimetype} {f.size} bytes\n{f.url_private}'
lines = (await self.parse_message(prefix + text, source, yelldest)).encode('utf-8')
for i in lines.split(b'\n'):
if not i:
continue
if isinstance(sl_ev, slack.ActionMessage):
i = b'\x01ACTION ' + i + b'\x01'
await self.sendmsg(
source,
dest,
i
)
async def _joined_parted(self, sl_ev: slack.Join|slack.Leave, joined: bool) -> None:
"""
Handle join events from slack, by sending a JOIN notification
to IRC.
"""
#Invalidate cache since the users in the channel changed
if sl_ev.channel in self._mentions_regex_cache:
del self._mentions_regex_cache[sl_ev.channel]
user = await self.sl_client.get_user(sl_ev.user)
if user.deleted:
return
channel = await self.sl_client.get_channel(sl_ev.channel)
dest = b'#' + channel.name.encode('utf8')
if dest in self.parted_channels:
return
name = user.name.encode('utf8')
rname = user.real_name.replace(' ', '_').encode('utf8')
if joined:
self.s.write(b':%s!%s@127.0.0.1 JOIN :%s\r\n' % (name, rname, dest))
else:
self.s.write(b':%s!%s@127.0.0.1 PART %s\r\n' % (name, rname, dest))
await self.s.drain()
async def slack_event(self, sl_ev: slack.SlackEvent) -> None:
if not self._usersent:
self._held_events.append(sl_ev)
return
if isinstance(sl_ev, slack.MessageDelete):
await self._message(sl_ev, '[deleted] ')
elif isinstance(sl_ev, slack.Message):
await self._message(sl_ev)
elif isinstance(sl_ev, slack.ActionMessage):
await self._message(sl_ev)
elif isinstance(sl_ev, slack.MessageEdit):
await self._messageedit(sl_ev)
elif isinstance(sl_ev, slack.MessageBot):
await self._message(sl_ev, '[%s] ' % sl_ev.username)
elif isinstance(sl_ev, slack.Join):
await self._joined_parted(sl_ev, True)
elif isinstance(sl_ev, slack.Leave):
await self._joined_parted(sl_ev, False)
elif isinstance(sl_ev, slack.TopicChange):
await self._sendreply(Replies.RPL_TOPIC, sl_ev.topic, ['#' + (await self.sl_client.get_channel(sl_ev.channel)).name])
elif isinstance(sl_ev, slack.GroupJoined) or isinstance(sl_ev, slack.MpimJoined):
channel_name = '#%s' % sl_ev.channel.name_normalized
await self._send_chan_info(channel_name.encode('utf-8'), sl_ev.channel)
elif isinstance(sl_ev, slack.PresenceChange):
user = await self.sl_client.get_user(sl_ev.user)
if sl_ev.away():
await self._sendreply(Replies.RPL_AWAY, f'{user.name} is away', extratokens=[user.name])
else:
await self._sendreply(Replies.RPL_UNAWAY, f'{user.name} is not away', extratokens=[user.name])
async def command(self, cmd: bytes) -> None:
if b' ' in cmd:
cmdid, _ = cmd.split(b' ', 1)
else:
cmdid = cmd
# commands are case insensitive
cmdid = cmdid.upper()
handlers = {
b'NICK': self._nickhandler,
b'USER': self._userhandler,
b'PING': self._pinghandler,
b'JOIN': self._joinhandler,
b'PRIVMSG': self._privmsghandler,
b'LIST': self._listhandler,
b'WHO': self._whohandler,
b'MODE': self._modehandler,
b'PART': self._parthandler,
b'AWAY': self._awayhandler,
b'TOPIC': self._topichandler,
b'KICK': self._kickhandler,
b'INVITE': self._invitehandler,
b'SENDFILE': self._sendfilehandler,
b'ANNOY': self._annoyhandler,
b'LISTANNOY': self._listannoyhandler,
b'DROPANNOY': self._dropannoyhandler,
b'AUTOREACT': self._autoreacthandler,
b'LISTAUTOREACT': self._listautoreacthandler,
b'DROPAUTOREACT': self._dropautoreacthandler,
b'QUIT': self._quithandler,
b'USERHOST': self._userhosthandler,
b'WHOIS': self._whoishandler,
b'ISON': self._isonhandler,
b'CAP': self._caphandler,
}
if cmdid in handlers:
await handlers[cmdid](cmd)
else:
await self._sendreply(Replies.ERR_UNKNOWNCOMMAND, 'Unknown command', [cmdid])
warning('Unknown command: ', cmd)
def su() -> None:
"""
switch user. Useful when starting localslackirc
as a service as root user.
"""
if sys.platform.startswith('win'):
return
# Nothing to do, already not root
if os.getuid() != 0:
return
username = environ.get('PROCESS_OWNER', 'nobody')
userdata = pwd.getpwnam(username)
os.setgid(userdata.pw_gid)
os.setegid(userdata.pw_gid)
os.setuid(userdata.pw_uid)
os.seteuid(userdata.pw_uid)
def main() -> None:
su()
parser = argparse.ArgumentParser(
description='Creates an IRC server running locally, which acts as a gateway to slack for one user.'
)
parser.add_argument('-v', '--version', action='version', version=f'''localslackirc {VERSION}''')
parser.add_argument('-p', '--port', type=int, action='store', dest='port',
default=9007, required=False,
help='set port number. Defaults to 9007')
parser.add_argument('-i', '--ip', type=str, action='store', dest='ip',
default='127.0.0.1', required=False,
help='set ip address')
parser.add_argument('-t', '--tokenfile', type=str, action='store', dest='tokenfile',
default=expanduser('~')+'/.localslackirc',
required=False,
help='set the token file')
parser.add_argument('-c', '--cookiefile', type=str, action='store', dest='cookiefile',
default=None,
required=False,
help='set the cookie file (for slack only, for xoxc tokens)')
parser.add_argument('-u', '--nouserlist', action='store_true',
dest='nouserlist', required=False,
help='don\'t display userlist')
parser.add_argument('--no-rejoin-on-mention', action='store_true', dest='no_rejoin_on_mention',
help='If set, mentions of the username will not cause the channel to be re-joined')
parser.add_argument('-j', '--autojoin', action='store_true',
dest='autojoin', required=False,
help="Automatically join all remote channels")
parser.add_argument('-o', '--override', action='store_true',
dest='overridelocalip', required=False,
help='allow non 127. addresses, this is potentially dangerous')
parser.add_argument('-f', '--status-file', type=str, action='store', dest='status_file', required=False, default=None,
help='Path to the file to keep the internal status.')
parser.add_argument('-d', '--debug', action='store_true', dest='debug', required=False, default=False,
help='Enables debugging logs.')
parser.add_argument('--log-suffix', type=str, action='store', dest='log_suffix', default='',
help='Set a suffix for the syslog identifier')
parser.add_argument('--ignored-channels', type=str, action='store', dest='ignored_channels', default='',
help='Comma separated list of channels to not join when autojoin is enabled')
parser.add_argument('--downloads-directory', type=str, action='store', dest='downloads_directory', default='.',
help='Where to create files for automatic downloads')
parser.add_argument('--formatted-max-lines', type=int, action='store', dest='formatted_max_lines', default=0,
help='Maximum amount of lines in a formatted text to send to the client rather than store in a file.\n'
'Setting to 0 (the default) will send everything to the client')
parser.add_argument('--silenced-yellers', type=str, action='store', dest='silenced_yellers', default='',
help='Comma separated list of nicknames that won\'t generate notifications when using @channel and @here')
parser.add_argument('--control-socket', type=str, action='store', dest='control_socket', default=None,
help='Path to where the unix control socket will be')
args = parser.parse_args()
openlog(environ.get('LOG_SUFFIX', args.log_suffix))
set_debug(environ.get('DEBUG', args.debug))
status_file_str: str | None = environ.get('STATUS_FILE', args.status_file)
status_file = None
if status_file_str is not None:
log('Status file at:', status_file_str)
status_file = Path(status_file_str)
ip: str = environ.get('IP_ADDRESS', args.ip)
overridelocalip: bool = environ['OVERRIDE_LOCAL_IP'].lower() == 'true' if 'OVERRIDE_LOCAL_IP' in environ else args.overridelocalip
# Exit if their chosden ip isn't local. User can override with -o if they so dare
if not ip.startswith('127') and not overridelocalip:
abort('supplied ip isn\'t local\nlocalslackirc has no encryption or ' \
'authentication, it\'s recommended to only allow local connections\n' \
'you can override this with -o')
port = int(environ.get('PORT', args.port))
autojoin: bool = environ['AUTOJOIN'].lower() == 'true' if 'AUTOJOIN' in environ else args.autojoin
nouserlist: bool = environ['NOUSERLIST'].lower() == 'true' if 'NOUSERLIST' in environ else args.nouserlist
no_rejoin_on_mention: bool = environ['NO_REJOIN_ON_MENTION'].lower() == 'true' if 'NO_REJOIN_ON_MENTION' in environ else args.no_rejoin_on_mention
# Splitting ignored channels
ignored_channels_str = environ.get('IGNORED_CHANNELS', args.ignored_channels)
if autojoin and len(ignored_channels_str):
ignored_channels: set[bytes] = {
(b'' if i.startswith('#') else b'#') + i.encode('ascii')
for i in ignored_channels_str.split(',')
}
else:
ignored_channels = set()
if 'DOWNLOADS_DIRECTORY' in environ:
downloads_directory = Path(environ['DOWNLOADS_DIRECTORY'])
else:
downloads_directory = Path(args.downloads_directory)
try:
formatted_max_lines = int(environ.get('FORMATTED_MAX_LINES', args.formatted_max_lines))
except:
abort('FORMATTED_MAX_LINES is not a valid int')
yellers_str = environ.get('SILENCED_YELLERS', args.silenced_yellers)
if yellers_str:
silenced_yellers = {i.strip().encode('utf8') for i in yellers_str.split(',')}
else:
silenced_yellers = set()
control_socket = environ.get('CONTROL_SOCKET', args.control_socket)
if 'TOKEN' in environ:
token = environ['TOKEN']
else:
try:
with open(args.tokenfile) as f:
token = f.readline().strip()
except IsADirectoryError:
abort(f'Not a file {args.tokenfile}')
except (FileNotFoundError, PermissionError):
abort(f'Unable to open the token file {args.tokenfile}')
if 'COOKIE' in environ:
cookie: str | None = environ['COOKIE']
else:
try:
if args.cookiefile:
with open(args.cookiefile) as f:
cookie = f.readline().strip()
else:
cookie = None
except (FileNotFoundError, PermissionError):
abort(f'Unable to open the cookie file {args.cookiefile}')
except IsADirectoryError:
abort(f'Not a file {args.cookiefile}')
if token.startswith('xoxc-') and not cookie:
abort('The cookie is needed for this kind of slack token')
provider = Provider.SLACK
# Parameters are dealt with
async def irc_listener() -> None:
previous_status = None
if status_file is not None:
if status_file.exists():
if not os.access(status_file, os.O_RDWR):
abort('Status file needs to have read write permissions')
previous_status = status_file.read_bytes()
else:
try:
status_file.write_bytes(b'')
except Exception as e:
abort(f'Failure when creating the status file {e}')
clientsettings = ClientSettings(
nouserlist=nouserlist,
no_rejoin_on_mention=no_rejoin_on_mention,
autojoin=autojoin,
provider=provider,
ignored_channels=ignored_channels,
downloads_directory=downloads_directory,
formatted_max_lines=formatted_max_lines,
silenced_yellers=silenced_yellers,
)
verify = clientsettings.verify()
if verify is not None:
abort(verify)
serversocket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
serversocket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
serversocket.bind((ip, port))
serversocket.listen(1)
serversocket.setblocking(False)
s, _ = await asyncio.get_running_loop().sock_accept(serversocket)
serversocket.close()
reader, writer = await asyncio.open_connection(sock=s)
sl_client = slack.Slack(token, cookie, previous_status)
await sl_client.login()
ircclient = Client(writer, sl_client, clientsettings)
try:
from_irc_task = asyncio.create_task(from_irc(reader, ircclient))
to_irc_task = asyncio.create_task(to_irc(sl_client, ircclient))
if control_socket:
import control
control_task = asyncio.create_task(control.listen(control_socket, ircclient))
else:
control_task = None
if control_task:
await asyncio.gather(
from_irc_task,
to_irc_task,
control_task,
)
else:
await asyncio.gather(
from_irc_task,
to_irc_task,
)
finally:
log('Closing connections')
sl_client.close()
if status_file:
log(f'Writing status to {status_file}')
status_file.write_bytes(sl_client.get_status())
writer.close()
log('Cancelling running tasks')
from_irc_task.cancel()
to_irc_task.cancel()
if control_task:
control_task.cancel()
async def restart_listener_loop():
loop = asyncio.get_running_loop()
loop.add_signal_handler(signal.SIGHUP, term_f)
loop.add_signal_handler(signal.SIGTERM, term_f)
loop.add_signal_handler(signal.SIGINT, term_f)
while True:
try:
await irc_listener()
except IrcDisconnectError:
log('IRC disconnected')
asyncio.run(restart_listener_loop())
async def from_irc(reader, ircclient: Client):
while True:
try:
cmd = await reader.readline()
except Exception:
raise IrcDisconnectError()
await ircclient.command(cmd.strip())
async def to_irc(sl_client: slack.Slack, ircclient: Client):
while True:
ev = await sl_client.event()
if ev:
debug(ev)
await ircclient.slack_event(ev)
def term_f(*args):
sys.exit(0)
if __name__ == '__main__':
try:
main()
except KeyboardInterrupt:
pass
|