adding the logbot to the git
This commit is contained in:
commit
1b1f6a857a
15
README.md
Normal file
15
README.md
Normal file
@ -0,0 +1,15 @@
|
||||
# logbot
|
||||
|
||||
A small XMPP bot written in Python (using the slixmpp library), that logs all images and messages with the mentioning of *@bot*.
|
||||
|
||||
To run it:
|
||||
|
||||
$ python3 logbot.py
|
||||
|
||||
Dependencies:
|
||||
|
||||
$ sudo pip3 install slixmpp
|
||||
|
||||
---
|
||||
|
||||
That's all for now!
|
||||
209
logbot.py
Normal file
209
logbot.py
Normal file
@ -0,0 +1,209 @@
|
||||
#!/usr/bin/env python3
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
"""
|
||||
Slixmpp: The Slick XMPP Library
|
||||
Copyright (C) 2010 Nathanael C. Fritz
|
||||
This file is part of Slixmpp.
|
||||
|
||||
See the file LICENSE for copying permission.
|
||||
"""
|
||||
|
||||
# Code source: https://git.poez.io/slixmpp/tree/examples/muc.py
|
||||
|
||||
# To run this bot:
|
||||
# $ python3 logbot.py --jid username@yourdomainname.ext --password password --room channel@groups.domainname.ext --nick nickname --output ./output/
|
||||
|
||||
|
||||
import logging
|
||||
from getpass import getpass
|
||||
from argparse import ArgumentParser
|
||||
|
||||
import slixmpp
|
||||
import ssl, os, requests, urllib
|
||||
|
||||
class MUCBot(slixmpp.ClientXMPP):
|
||||
"""
|
||||
A simple Slixmpp bot that will save images
|
||||
and messages that are marked with @bot to a folder.
|
||||
"""
|
||||
|
||||
def __init__(self, jid, password, room, nick, output):
|
||||
slixmpp.ClientXMPP.__init__(self, jid, password)
|
||||
|
||||
self.room = room
|
||||
self.nick = nick
|
||||
self.output = output
|
||||
|
||||
# The session_start event will be triggered when
|
||||
# the bot establishes its connection with the server
|
||||
# and the XML logs 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)
|
||||
|
||||
|
||||
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.
|
||||
"""
|
||||
|
||||
self.get_roster()
|
||||
self.send_presence()
|
||||
|
||||
# https://xmpp.org/extensions/xep-0045.html
|
||||
self.plugin['xep_0045'].join_muc(self.room,
|
||||
self.nick,
|
||||
# If a room password is needed, use:
|
||||
# password=the_room_password,
|
||||
wait=True)
|
||||
|
||||
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('Message: {}'.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:
|
||||
|
||||
# Check if an OOB URL is included in the stanza (which is how an image is sent)
|
||||
# (OOB object - https://xmpp.org/extensions/xep-0066.html#x-oob)
|
||||
if len(msg['oob']['url']) > 0:
|
||||
|
||||
# Check if output folder exists
|
||||
if not os.path.exists(self.output):
|
||||
os.mkdir(self.output)
|
||||
|
||||
# Send a reply
|
||||
self.send_message(mto=self.room,
|
||||
mbody="Super, our log is growing. Your image is added!",
|
||||
mtype='groupchat')
|
||||
|
||||
Save the image to the output folder
|
||||
url = msg['oob']['url'] # grep the url in the message
|
||||
filename = os.path.basename(url) # grep the filename in the url
|
||||
output_path = os.path.join(output, filename)
|
||||
u = urllib.request.urlopen(url) # read the image data
|
||||
f = open(output_path, 'wb') # open the output file
|
||||
f.write(u.read()) # write image to file
|
||||
f.close() # close the output file
|
||||
|
||||
# Add image to log
|
||||
img = '<img class="image" src="{}">'.format(msg['oob']['url'])
|
||||
log = 'log.html'
|
||||
log_path = os.path.join(output, log)
|
||||
f = open(log_path, 'a+')
|
||||
f.write(img+'\n')
|
||||
f.close()
|
||||
|
||||
|
||||
# Include messages in the log (only when '#publish' is used in the message)
|
||||
if '@bot' in msg['body']:
|
||||
|
||||
# reply from the bot
|
||||
self.send_message(mto=self.room,
|
||||
mbody="Noted! And added to the log. Thanks {}!".format(msg['mucnick']),
|
||||
mtype='groupchat')
|
||||
|
||||
# Add message to log
|
||||
message = '<p class="message">{}</p>'.format(msg['body'])
|
||||
output = self.output
|
||||
log = 'log.html'
|
||||
log_path = os.path.join(output, log)
|
||||
f = open(log_path, 'a+')
|
||||
f.write(message+'\n')
|
||||
f.close()
|
||||
|
||||
if __name__ == '__main__':
|
||||
# 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 folder for images
|
||||
parser.add_argument("-o", "--output", dest="output",
|
||||
help="output folder, this is where the files are stored",
|
||||
default="./output/", 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("XMPP address: ")
|
||||
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("Output folder: ")
|
||||
|
||||
# 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
|
||||
xmpp.register_plugin('xep_0066') # Process URI's (files, images)
|
||||
|
||||
# Connect to the XMPP server and start processing XMPP stanzas.
|
||||
xmpp.connect()
|
||||
xmpp.process()
|
||||
|
||||
Loading…
Reference in New Issue
Block a user