class UserGroup:
"""
UserGroup object, mostly exists for a speedy way to apply a PermissionsMask to a large amount of users at once
"""
def __init__(self, name, hallo):
"""
Constructor
:param name: Name of the user group
:type name: str
:param hallo: Hallo object which owns the user group
:type hallo: hallo.Hallo
"""
self.user_list = set() # Dynamic userlist of this group
""":type : set[Destination.User]"""
self.hallo = hallo # Hallo instance that owns this UserGroup
""":type : Hallo.Hallo"""
self.name = name # Name of the UserGroup
""":type : str"""
self.permission_mask = PermissionMask() # PermissionMask for the UserGroup
""":type : PermissionMask"""
def __eq__(self, other):
return (self.hallo, self.name) == (self.hallo, other.name)
def __hash__(self):
return (self.hallo, self.name).__hash__()
def rights_check(self, right_name, user_obj, channel_obj=None):
"""Checks the value of the right with the specified name. Returns boolean
:param right_name: Name of the right to check
:type right_name: str
:param user_obj: User which is having rights checked
:type user_obj: destination.User
:param channel_obj: Channel in which rights are being checked, None for private messages
:type channel_obj: destination.Channel | None
:rtype: bool
"""
right_value = self.permission_mask.get_right(right_name)
# PermissionMask contains that right, return it.
if right_value in [True, False]:
return right_value
# Fall back to channel, if defined
if channel_obj is not None:
return channel_obj.rights_check(right_name)
# Fall back to the parent Server's decision.
return user_obj.server.rights_check(right_name)
def get_name(self):
return self.name
def get_permission_mask(self):
return self.permission_mask
def set_permission_mask(self, new_permission_mask):
"""
Sets the permission mask of the user group
:param new_permission_mask: Permission mask to set for user group
:type new_permission_mask: PermissionMask.PermissionMask
"""
self.permission_mask = new_permission_mask
def get_hallo(self):
return self.hallo
def add_user(self, new_user):
"""
Adds a new user to this group
:param new_user: User to add to group
:type new_user: destination.User
"""
self.user_list.add(new_user)
def remove_user(self, remove_user):
self.user_list.remove(remove_user)
def to_json(self):
"""
Returns the user group configuration as a dict for serialisation into json
:return: dict
"""
json_obj = dict()
json_obj["name"] = self.name
if not self.permission_mask.is_empty():
json_obj["permission_mask"] = self.permission_mask.to_json()
return json_obj
@staticmethod
def from_json(json_obj, hallo):
"""
Creates a UserGroup object from json object dictionary
:param json_obj: json object dictionary
:type json_obj: dict
:param hallo: root hallo object
:type hallo: hallo.Hallo
:return: new user group
:rtype: UserGroup
"""
new_group = UserGroup(json_obj["name"], hallo)
if "permission_mask" in json_obj:
new_group.permission_mask = PermissionMask.from_json(
json_obj["permission_mask"]
)
return new_group
class ServerTelegram(Server):
type = Server.TYPE_TELEGRAM
image_extensions = ["jpg", "jpeg", "png"]
def __init__(self, hallo, api_key):
super().__init__(hallo)
"""
Constructor for server object
:param hallo: Hallo Instance of hallo that contains this server object
:type hallo: Hallo.Hallo
"""
self.hallo = hallo # The hallo object that created this server
# Persistent/saved class variables
self.api_key = api_key
self.name = "Telegram" # Server name #TODO: needs to be configurable!
self.auto_connect = (
True # Whether to automatically connect to this server when hallo starts
)
self.channel_list = (
[]
) # List of channels on this server (which may or may not be currently active)
""" :type : list[Destination.Channel]"""
self.user_list = [
] # Users on this server (not all of which are online)
""" :type : list[Destination.User]"""
self.nick = None # Nickname to use on this server
self.prefix = None # Prefix to use with functions on this server
self.full_name = None # Full name to use on this server
self.permission_mask = PermissionMask(
) # PermissionMask for the server
# Dynamic/unsaved class variables
self.state = Server.STATE_CLOSED # Current state of the server, replacing open
self._connect_lock = Lock()
request = Request(con_pool_size=8)
self.bot = telegram.Bot(token=self.api_key, request=request)
self.bot.logger.setLevel(logging.INFO)
self.updater = Updater(bot=self.bot)
self.dispatcher = self.updater.dispatcher
logging.basicConfig(
format="%(asctime)s - %(name)s - %(levelname)s - %(message)s",
level=logging.ERROR,
)
# Message handlers
self.private_msg_handler = MessageHandler(Filters.private,
self.parse_private_message)
self.dispatcher.add_handler(self.private_msg_handler)
self.group_msg_handler = MessageHandler(Filters.group,
self.parse_group_message)
self.dispatcher.add_handler(self.group_msg_handler)
# Catch-all message handler for anything not already handled.
self.core_msg_handler = MessageHandler(Filters.all,
self.parse_unhandled,
channel_post_updates=True)
self.dispatcher.add_handler(self.core_msg_handler)
class ChannelFilter(BaseFilter):
def filter(self, message):
return message.chat.type in [Chat.CHANNEL]
def start(self):
"""
Starts up the server and launches the new thread
"""
if self.state != Server.STATE_CLOSED:
raise ServerException("Already started.")
self.state = Server.STATE_CONNECTING
with self._connect_lock:
Thread(target=self.connect).start()
def connect(self):
"""
Internal method
Method to read from stream and process. Will connect and call internal parsing methods or whatnot.
Needs to be started in it's own thread, only exits when the server connection ends
"""
with self._connect_lock:
self.updater.start_polling()
self.state = Server.STATE_OPEN
def disconnect(self, force=False):
self.state = Server.STATE_DISCONNECTING
with self._connect_lock:
self.updater.stop()
self.state = Server.STATE_CLOSED
def reconnect(self):
super().reconnect()
def parse_private_message(self, update, context):
"""
Handles a new private message
:param update: Update object from telegram API
:type update: telegram.Update
:param context: Callback Context from the telegram API
:type context: telegram.CallbackContext
"""
# Get sender object
telegram_chat = update.message.chat
names_list = [telegram_chat.first_name, telegram_chat.last_name]
message_sender_name = " ".join(
[name for name in names_list if name is not None])
message_sender_addr = update.message.chat.id
message_sender = self.get_user_by_address(message_sender_addr,
message_sender_name)
message_sender.update_activity()
# Create Event object
if update.message.photo:
photo_id = update.message.photo[-1]["file_id"]
message_text = update.message.caption or ""
message_evt = EventMessageWithPhoto(self, None, message_sender,
message_text,
photo_id).with_raw_data(
RawDataTelegram(update))
else:
message_text = update.message.text
message_evt = EventMessage(self, None, message_sender,
message_text).with_raw_data(
RawDataTelegram(update))
# Print and Log the private message
message_evt.log()
self.hallo.function_dispatcher.dispatch(message_evt)
def parse_group_message(self, update, context):
"""
Handles a new group or supergroup message (does not handle channel posts)
:param update: Update object from telegram API
:type update: telegram.Update
:param context: Callback Context from the telegram API
:type context: telegram.CallbackContext
"""
# Get sender object
message_sender_name = " ".join([
update.message.from_user.first_name,
update.message.from_user.last_name
])
message_sender_addr = update.message.from_user.id
message_sender = self.get_user_by_address(message_sender_addr,
message_sender_name)
message_sender.update_activity()
# Get channel object
message_channel_name = update.message.chat.title
message_channel_addr = update.message.chat.id
message_channel = self.get_channel_by_address(message_channel_addr,
message_channel_name)
message_channel.update_activity()
# Create message event object
if update.message.photo:
photo_id = update.message.photo[-1]["file_id"]
message_text = update.message.caption or ""
message_evt = EventMessageWithPhoto(self, message_channel,
message_sender, message_text,
photo_id).with_raw_data(
RawDataTelegram(update))
else:
message_text = update.message.text
message_evt = EventMessage(self, message_channel, message_sender,
message_text).with_raw_data(
RawDataTelegram(update))
# Print and log the public message
message_evt.log()
# Send event to function dispatcher or passive dispatcher
function_dispatcher = self.hallo.function_dispatcher
if message_evt.is_prefixed:
if message_evt.is_prefixed is True:
function_dispatcher.dispatch(message_evt)
else:
function_dispatcher.dispatch(message_evt,
[message_evt.is_prefixed])
else:
function_dispatcher.dispatch_passive(message_evt)
def parse_join(self, update, context):
# TODO
pass
def parse_unhandled(self, update, context):
"""
Parses an unhandled message from the server
:param update: Update object from telegram API
:type update: telegram.Update
:param context: Callback Context from the telegram API
:type context: telegram.CallbackContext
"""
# Print it to console
error = MessageError(
"Unhandled data received on Telegram server: {}".format(update))
logger.error(error.get_log_line())
def formatting_to_telegram_mode(self, event_formatting):
"""
:type event_formatting: EventMessage.Formatting
:rtype: telegram.ParseMode
"""
return {
EventMessage.Formatting.MARKDOWN: telegram.ParseMode.MARKDOWN,
EventMessage.Formatting.HTML: telegram.ParseMode.HTML,
}.get(event_formatting)
def send(self, event):
if isinstance(event, EventMessageWithPhoto):
destination = event.user if event.channel is None else event.channel
try:
if isinstance(event.photo_id, list):
media = [InputMediaPhoto(x) for x in event.photo_id]
media[0].caption = event.text
media[0].parse_mode = self.formatting_to_telegram_mode(
event.formatting)
msg = self.bot.send_media_group(
chat_id=destination.address, media=media)
elif any([
event.photo_id.lower().endswith("." + x)
for x in ServerTelegram.image_extensions
]):
msg = self.bot.send_photo(
chat_id=destination.address,
photo=event.photo_id,
caption=event.text,
parse_mode=self.formatting_to_telegram_mode(
event.formatting),
)
else:
msg = self.bot.send_document(
chat_id=destination.address,
document=event.photo_id,
caption=event.text,
parse_mode=self.formatting_to_telegram_mode(
event.formatting),
)
except Exception as e:
logger.warning(
"Failed to send message with picture. Sending without. Picture path %s",
event.photo_id,
exc_info=e)
msg = self.bot.send_message(
chat_id=destination.address,
text=event.text,
parse_mode=self.formatting_to_telegram_mode(
event.formatting))
event.with_raw_data(RawDataTelegramOutbound(msg))
event.log()
return event
if isinstance(event, EventMessage):
destination = event.user if event.channel is None else event.channel
msg = self.bot.send_message(
chat_id=destination.address,
text=event.text,
parse_mode=self.formatting_to_telegram_mode(event.formatting),
)
event.with_raw_data(RawDataTelegramOutbound(msg))
event.log()
return event
else:
error = MessageError(
"Unsupported event type, {}, sent to Telegram server".format(
event.__class__.__name__))
logger.error(error.get_log_line())
raise NotImplementedError()
def reply(self, old_event, new_event):
"""
:type old_event: events.ChannelUserTextEvent
:param new_event:
:return:
"""
# Do checks
super().reply(old_event, new_event)
if old_event.raw_data is None or not isinstance(
old_event.raw_data, RawDataTelegram):
raise ServerException(
"Old event has no telegram data associated with it")
# Send event
if isinstance(new_event, EventMessageWithPhoto):
destination = (new_event.user
if new_event.channel is None else new_event.channel)
old_message_id = old_event.raw_data.update_obj.message.message_id
if any([
new_event.photo_id.lower().endswith("." + x)
for x in ServerTelegram.image_extensions
]):
self.bot.send_photo(
destination.address,
new_event.photo_id,
caption=new_event.text,
reply_to_message_id=old_message_id,
parse_mode=self.formatting_to_telegram_mode(
new_event.formatting),
)
else:
self.bot.send_document(
destination.address,
new_event.photo_id,
caption=new_event.text,
reply_to_message_id=old_message_id,
parse_mode=self.formatting_to_telegram_mode(
new_event.formatting),
)
new_event.log()
return
if isinstance(new_event, EventMessage):
destination = (new_event.user
if new_event.channel is None else new_event.channel)
old_message_id = old_event.raw_data.update_obj.message.message_id
self.bot.send_message(
destination.address,
new_event.text,
reply_to_message_id=old_message_id,
parse_mode=self.formatting_to_telegram_mode(
new_event.formatting),
)
new_event.log()
return
else:
error = MessageError(
"Unsupported event type, {}, sent as reply to Telegram server".
format(new_event.__class__.__name__))
logger.error(error.get_log_line())
raise NotImplementedError()
def get_name_by_address(self, address):
chat = self.bot.get_chat(address)
if chat.type == chat.PRIVATE:
return " ".join([chat.first_name, chat.last_name])
if chat.type in [chat.GROUP, chat.SUPERGROUP, chat.CHANNEL]:
return chat.title
def to_json(self):
"""
Creates a dict of configuration for the server, to store as json
:return: dict
"""
json_obj = dict()
json_obj["type"] = Server.TYPE_TELEGRAM
json_obj["name"] = self.name
json_obj["auto_connect"] = self.auto_connect
json_obj["channels"] = []
for channel in self.channel_list:
json_obj["channels"].append(channel.to_json())
json_obj["users"] = []
for user in self.user_list:
json_obj["users"].append(user.to_json())
if self.nick is not None:
json_obj["nick"] = self.nick
if self.prefix is not None:
json_obj["prefix"] = self.prefix
if not self.permission_mask.is_empty():
json_obj["permission_mask"] = self.permission_mask.to_json()
json_obj["api_key"] = self.api_key
return json_obj
@staticmethod
def from_json(json_obj, hallo):
api_key = json_obj["api_key"]
new_server = ServerTelegram(hallo, api_key)
new_server.name = json_obj["name"]
new_server.auto_connect = json_obj["auto_connect"]
if "nick" in json_obj:
new_server.nick = json_obj["nick"]
if "prefix" in json_obj:
new_server.prefix = json_obj["prefix"]
if "permission_mask" in json_obj:
new_server.permission_mask = PermissionMask.from_json(
json_obj["permission_mask"])
for channel in json_obj["channels"]:
new_server.add_channel(Channel.from_json(channel, new_server))
for user in json_obj["users"]:
new_server.add_user(User.from_json(user, new_server))
return new_server
def join_channel(self, channel_obj):
pass
# TODO
def check_user_identity(self, user_obj):
return True
