diff --git a/README.md b/README.md index 909624d..4ac505d 100644 --- a/README.md +++ b/README.md @@ -9,16 +9,7 @@ When the streambot is listening ... it saves all images that are sent to the muc *streambot.py* is based on *archivist.py*. It is a custom Varia bot that will communicate one day with our Pelican plugins-custom/stream plugin. :) -# git hooks (disabled at the moment) - -There are git-hooks enabled that will stop and (re)start streambot on every commit. - -**pre-receive**: streambot is stopped - -**post-update**: the repository is updated with a pull, streambot is started - - -# start streambot manually +# run streambot on the server To start the streambot: @@ -36,3 +27,12 @@ Error logs go to: sudo journalctl -xe + +# git hooks (disabled at the moment) + +There are git-hooks enabled that will stop and (re)start streambot on every commit. + +**pre-receive**: streambot is stopped + +**post-update**: the repository is updated with a pull, streambot is started + diff --git a/avatar.png b/avatar.png new file mode 100644 index 0000000..0892486 Binary files /dev/null and b/avatar.png differ diff --git a/contact.png b/contact.png deleted file mode 100644 index c01a169..0000000 Binary files a/contact.png and /dev/null differ diff --git a/streambot.py b/streambot.py index d8872ba..c12b3c9 100644 --- a/streambot.py +++ b/streambot.py @@ -1,105 +1,255 @@ -import logging - -import argparse -from sleekxmpp import ClientXMPP -from sleekxmpp.exceptions import IqError, IqTimeout -import os, subprocess -import urllib -import datetime -import ssl -from PIL import Image - -parser = argparse.ArgumentParser() -parser.add_argument("-j", "--jid", help="jabber identifier", type=str, required=True) -parser.add_argument("-p", "--password", help="password", type=str, required=True) -parser.add_argument("-m", "--muc", help="destination muc", type=str, required=True) -parser.add_argument("-n", "--nick", help="nickname of the bot", default="archivist", type=str) -parser.add_argument("-o", "--output", help="output folder", default="files/", type=str) -args = parser.parse_args() - -class ArchivistBot(ClientXMPP): - - def __init__(self, jid, password, room, nick, output): - ClientXMPP.__init__(self, jid, password) - - self.datadir = output - self.room = room - self.nick = nick +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- - self.add_event_handler("session_start", self.session_start) - self.add_event_handler("message", self.archive_msg) # by using 'message' instead of 'groupchat_message' every message received can be archived (also personal msgs) - - # self.add_event_handler("groupchat_message", self.archive_msg2) +""" + Slixmpp: The Slick XMPP Library + Copyright (C) 2010 Nathanael C. Fritz + This file is part of Slixmpp. - self.register_plugin('xep_0045') - self.register_plugin('xep_0030') - self.register_plugin('xep_0084') - self.register_plugin('xep_0096') # Transfer files.. - self.register_plugin('xep_0066') # Transfer files.. - - def session_start(self, event): - self.get_roster() - self.send_presence() - self.plugin['xep_0045'].joinMUC(self.room, self.nick) + See the file LICENSE for copying permission. +""" - # XEP-0084 User Avatar - # Requires SleekXMPP 81b7b2c1908e0f6a5435ce67745b5f4dafb59816 +# Code source: https://git.poez.io/slixmpp/tree/examples/muc.py - with open('contact.png', 'rb') as avatar_file: - avatar = avatar_file.read() - avatar_id = self['xep_0084'].generate_id(avatar) - info = { - 'id': avatar_id, - 'type': 'image/jpeg', - 'bytes': len(avatar) - } - self['xep_0084'].publish_avatar(avatar) - self['xep_0084'].publish_avatar_metadata(items=[info]) +# To run this script (local): +# $ python3 streambot.py -j streambot@vvvvvvaria.org -p slowstreaming -r test@muc.vvvvvvaria.org -n streambot -o ./stream/ - # XEP-0153: vCard-Based Avatars - # Not working ATM - self['xep_0153'].set_avatar(avatar=avatar, mtype='image/png') +import logging +from getpass import getpass +from argparse import ArgumentParser - def archive_msg(self, msg): - # Always check that a message is not from yourself, otherwise you will create an infinite loop responding to your own messages. - if 'mucnick' in msg and msg['mucnick'] == self.nick: - return +import slixmpp - if msg['oob']['url']: - logging.getLogger().debug("received OOB from %s with %s" % (self.nick, msg['oob']['url'])) +import ssl, os, requests, urllib - filename = os.path.basename(msg['oob']['url']) - targetDir = self.datadir - if not os.path.exists(targetDir): - os.mkdir( targetDir, '0755' ) - targetFile = os.path.join(targetDir, filename) +class MUCBot(slixmpp.ClientXMPP): - #needed to disable certificate validation: - ctx = ssl.create_default_context() - ctx.check_hostname = False - ctx.verify_mode = ssl.CERT_NONE + """ + A simple Slixmpp bot that will greets those + who enter the room, and acknowledge any messages + that mentions the bot's nickname. + """ - # save image to file - urllib.urlretrieve(msg['oob']['url'], targetFile, context=ctx) - logging.getLogger().debug("saved to %s" % targetFile) + def __init__(self, jid, password, room, nick, output): + slixmpp.ClientXMPP.__init__(self, jid, password) - subprocess.call(["make","publish"], cwd="/srv/gitea/clones/varia.website/") + self.room = room + self.nick = nick + self.datadir = output - # if msg['type'] in ('chat', 'normal'): - # msg.reply("Thanks for sending\n%(body)s" % msg).send() + # The session_start event will be triggered when + # the bot establishes its connection with the server + # and the XML streams are ready for use. We want to + # listen for this event so that we we can initialize + # our roster. + self.add_event_handler("session_start", self.start) + + # The groupchat_message event is triggered whenever a message + # stanza is received from any chat room. If you also also + # register a handler for the 'message' event, MUC messages + # will be processed by both handlers. + self.add_event_handler("groupchat_message", self.muc_message) + + # The groupchat_presence event is triggered whenever a + # presence stanza is received from any chat room, including + # any presences you send yourself. To limit event handling + # to a single room, use the events muc::room@server::presence, + # muc::room@server::got_online, or muc::room@server::got_offline. + self.add_event_handler("muc::{}::got_online".format(self.room), self.muc_online) + + + def start(self, event): + """ + Process the session_start event. + + Typical actions for the session_start event are + requesting the roster and broadcasting an initial + presence stanza. + + Arguments: + event -- An empty dictionary. The session_start + event does not provide any additional + data. + """ + self.get_roster() + self.send_presence() + self.plugin['xep_0045'].join_muc(self.room, + self.nick, + # If a room password is needed, use: + # password=the_room_password, + wait=True) + + self.register_plugin('xep_0066') # To send URI's (files, images) + # Needed to work with images + # This makes slixmpp understand an OOB object - https://xmpp.org/extensions/xep-0066.html#x-oob + + def muc_message(self, msg): + """ + Process incoming message stanzas from any chat room. Be aware + that if you also have any handlers for the 'message' event, + message stanzas may be processed by both handlers, so check + the 'type' attribute when using a 'message' event handler. + + Whenever the bot's nickname is mentioned, respond to + the message. + + IMPORTANT: Always check that a message is not from yourself, + otherwise you will create an infinite loop responding + to your own messages. + + This handler will reply to messages that mention + the bot's nickname. + + Arguments: + msg -- The received message stanza. See the documentation + for stanza objects and the Message stanza to see + how it may be used. + """ + + # some inspection commands + # print('\nMessage:{}'.format(msg)) + # print('\nMessage TYPE:{}'.format(msg['type'])) + # print('\nMessage body:{}'.format(msg['body'])) + # print('\nMessage OOB:{}'.format(msg['oob'])) + # print('\nMessage OOB URL:{}'.format(msg['oob']['url'])) + # print('\nMessage MUCK NICK:{}'.format(msg['mucnick'])) + + # Always check that a message is not the bot itself, otherwise you will create an infinite loop responding to your own messages. + if msg['mucnick'] != self.nick: + + # publish images + if len(msg['oob']['url']) > 0: + + url = msg['oob']['url'] + filename = os.path.basename(url) + targetDir = self.datadir + + if not os.path.exists(targetDir): + os.mkdir(targetDir, '0755') + + targetFile = os.path.join(targetDir, filename) + + # response = requests.get(url) + # if response.status_code == 200: + # with open(targetFile, 'wb') as f: + # f.write(response.content) + + # needed to disable certificate validation: + ctx = ssl.create_default_context() + ctx.check_hostname = False + ctx.verify_mode = ssl.CERT_NONE + + # save image to file + # urllib.request.urlretrieve(msg['oob']['url'], targetFile, context=ctx) + u = urllib.request.urlopen(url, context=ctx) + f = open(targetFile, 'wb') + f.write(u.read()) + f.close() + + # add image to the stream markdown log + stream_update = '![An image sent over XMPP]({})'.format(targetFile) + + filename = 'stream.md' + targetFile = os.path.join(targetDir, filename) + + f = open(targetFile, 'a+') + f.write(stream_update+'\n\n') + f.close() + + # publish regular messages (only when '#publish' is used in the message) + if '#stream' in msg['body']: + self.send_message(mto=msg['from'].bare, + mbody="I'll stream that further, {}.".format(msg['mucnick']), + mtype='groupchat') + + # add message to the stream markdown log + stream_update = msg['body'] + + targetDir = self.datadir + if not os.path.exists(targetDir): + os.mkdir(targetDir, '0755') + + filename = 'stream.md' + targetFile = os.path.join(targetDir, filename) + + f = open(targetFile, 'a+') + f.write(stream_update+'\n\n') + f.close() + + + # def muc_online(self, presence): + # """ + # Process a presence stanza from a chat room. In this case, + # presences from users that have just come online are + # handled by sending a welcome message that includes + # the user's nickname and role in the room. + + # Arguments: + # presence -- The received presence stanza. See the + # documentation for the Presence stanza + # to see how else it may be used. + # """ + # if presence['muc']['nick'] != self.nick and presence['muc']['nick'] != '': + # self.send_message(mto=presence['from'].bare, + # mbody="Hello, {} {}".format(presence['muc']['role'], presence['muc']['nick']), + # mtype='groupchat') if __name__ == '__main__': - # Ideally use optparse or argparse to get JID, - # password, and log level. - - logging.basicConfig(level=logging.DEBUG, format='%(levelname)-8s %(message)s') - - client = ArchivistBot(args.jid, args.password, args.muc, args.nick, args.output) + # Setup the command line arguments. + parser = ArgumentParser() + + # Output verbosity options. + parser.add_argument("-q", "--quiet", help="set logging to ERROR", + action="store_const", dest="loglevel", + const=logging.ERROR, default=logging.INFO) + parser.add_argument("-d", "--debug", help="set logging to DEBUG", + action="store_const", dest="loglevel", + const=logging.DEBUG, default=logging.INFO) + + # JID and password options. + parser.add_argument("-j", "--jid", dest="jid", + help="JID to use") + parser.add_argument("-p", "--password", dest="password", + help="password to use") + parser.add_argument("-r", "--room", dest="room", + help="MUC room to join") + parser.add_argument("-n", "--nick", dest="nick", + help="MUC nickname") + + # Output directory for images + parser.add_argument("-o", "--output", dest="output", + help="Output folder, this is where the material is stored", + default="./stream/", type=str) + + args = parser.parse_args() + + # Setup logging. + logging.basicConfig(level=args.loglevel, + format='%(levelname)-8s %(message)s') + + if args.jid is None: + args.jid = input("Username: ") + if args.password is None: + args.password = getpass("Password: ") + if args.room is None: + args.room = input("MUC room: ") + if args.nick is None: + args.nick = input("MUC nickname: ") + if args.output is None: + args.output = input("Directory where the material can be stored: ") + + # Setup the MUCBot and register plugins. Note that while plugins may + # have interdependencies, the order in which you register them does + # not matter. + xmpp = MUCBot(args.jid, args.password, args.room, args.nick, args.output) + xmpp.register_plugin('xep_0030') # Service Discovery + xmpp.register_plugin('xep_0045') # Multi-User Chat + xmpp.register_plugin('xep_0199') # XMPP Ping + + # Connect to the XMPP server and start processing XMPP stanzas. + xmpp.connect() + xmpp.process() - if client.connect(): - client.process(block=True) - else: - logging.getLogger().error("Can't connect.") diff --git a/streambot.sleekxmpp.py b/streambot.sleekxmpp.py new file mode 100644 index 0000000..c9db2ad --- /dev/null +++ b/streambot.sleekxmpp.py @@ -0,0 +1,132 @@ +import logging + +import argparse +from sleekxmpp import ClientXMPP +from sleekxmpp.exceptions import IqError, IqTimeout +import os, subprocess +import urllib.request +import datetime +import ssl +from PIL import Image +from pprint import pprint + +# python3 streambot.py -j streambot@vvvvvvaria.org -p ******* -m test@muc.vvvvvvaria.org -o ./stream/ + +# rewrite script to work with slixmpp >>> https://slixmpp.readthedocs.io/getting_started/muc.html + +parser = argparse.ArgumentParser() +parser.add_argument("-j", "--jid", help="jabber identifier", type=str, required=True) +parser.add_argument("-p", "--password", help="password", type=str, required=True) +parser.add_argument("-m", "--muc", help="destination muc", type=str, required=True) +parser.add_argument("-n", "--nick", help="nickname of the bot", default="streambot", type=str) +parser.add_argument("-o", "--output", help="output folder", default="./stream/", type=str) +args = parser.parse_args() + +# This was a useful tutorial: http://sleekxmpp.com/getting_started/echobot.html#echobot + +class ArchivistBot(ClientXMPP): + + def __init__(self, jid, password, room, nick, output): + ClientXMPP.__init__(self, jid, password) + + self.datadir = output + self.room = room + self.nick = nick + + self.add_event_handler("session_start", self.session_start) + self.add_event_handler("message", self.archive_msg) # by using 'message' instead of 'groupchat_message' every message received can be archived (also personal msgs) + + # self.add_event_handler("groupchat_message", self.archive_msg2) + + self.register_plugin('xep_0045') + self.register_plugin('xep_0030') + self.register_plugin('xep_0084') + self.register_plugin('xep_0096') # Transfer files.. + self.register_plugin('xep_0066') # Transfer files.. + + def session_start(self, event): + roster = self.get_roster() + print('\nRoster:', roster) + + self.send_presence() + + self.plugin['xep_0045'].joinMUC(self.room, self.nick) # MUC plugin + + with open('avatar.png', 'rb') as avatar_file: + avatar = avatar_file.read() + avatar_id = self['xep_0084'].generate_id(avatar) + info = { + 'id': avatar_id, + 'type': 'image/png', + 'bytes': len(avatar) + } + self['xep_0084'].publish_avatar(avatar) + self['xep_0084'].publish_avatar_metadata(items=[info]) + + # XEP-0153: vCard-Based Avatars + # Not working ATM + + self['xep_0153'].set_avatar(avatar=avatar, mtype='image/png') + + def archive_msg(self, msg): + print('\nMessage:{}'.format(msg)) + print('\nMessage TYPE:{}'.format(msg['type'])) + print('\nMessage OOB:{}'.format(msg['oob'])) + print('\nMessage OOB URL:{}'.format(msg['oob']['url'])) + print('\nMessage MUCK NICK:{}'.format(msg['mucnick'])) + + # Always check that a message is not the bot itself, otherwise you will create an infinite loop responding to your own messages. + if msg['mucnick'] != self.nick: + + if msg['type'] in ('groupchat', 'normal'): + + # only works if messages are not encrypted + if len(msg['oob']['url']) > 0: + + # logging.getLogger().debug("received OOB from %s with %s" % (self.nick, msg['oob']['url'])) + + filename = os.path.basename(msg['oob']['url']) + targetDir = self.datadir + if not os.path.exists(targetDir): + os.mkdir(targetDir, '0755') + + targetFile = os.path.join(targetDir, filename) + print('\n targetFile', targetFile) + + #needed to disable certificate validation: + ctx = ssl.create_default_context() + ctx.check_hostname = False + ctx.verify_mode = ssl.CERT_NONE + + # save image to file + # urllib.request.urlretrieve(msg['oob']['url'], targetFile, context=ctx) + # with urllib.request.urlopen(msg['oob']['url'], context=ctx) as u, \ + # open(targetFile, 'w+') as f: + # f.write(u.read()) + # f.close() + + # Download the file from `url` and save it locally under `file_name`: + with urllib.request.urlopen(msg['oob']['url']) as response: + data = response.read() # a `bytes` object + f = open(targetFile, 'wb') + f.write(data) + logging.getLogger().debug("saved to %s" % targetFile) + + # subprocess.call(["make","publish"], cwd="/srv/gitea/clones/varia.website/") + + msg.reply("Thanks for sending! I will store that for you." % msg).send() # works! also for omemo messages, but it cannot decrypt them. + + + +if __name__ == '__main__': + # Ideally use optparse or argparse to get JID, + # password, and log level. + + logging.basicConfig(level=logging.DEBUG, format='%(levelname)-8s %(message)s') + + client = ArchivistBot(args.jid, args.password, args.muc, args.nick, args.output) + + if client.connect(): + client.process(block=True) + else: + logging.getLogger().error("Can't connect.")