Skip to content

UTF-8, delayed posts, keyword filtering, tinyurl errors and more colors. #55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Sep 5, 2019
Merged

UTF-8, delayed posts, keyword filtering, tinyurl errors and more colors. #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
e15b738
Update README.md
Wibol May 1, 2019
05dec90
Update README.md
Wibol May 1, 2019
c961564
Update bot.py
Wibol May 1, 2019
7a2c0ac
Update colour.py
Wibol May 1, 2019
06679fd
Update db.py
Wibol May 1, 2019
c146826
Update bot.py
Wibol May 1, 2019
e8d43d8
Update colour.py
Wibol May 1, 2019
5465439
Update feedupdater.py
Wibol May 1, 2019
53613d8
Update main.py
Wibol May 1, 2019
775c79b
Update config.py.sample
Wibol May 1, 2019
f35674a
Update main.py
Wibol May 2, 2019
85629f1
Update bot.py
Wibol May 2, 2019
632e3b0
Update feedupdater.py
Wibol May 2, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,12 @@ This is a simple bot which fetches RSS feeds and posts them to an IRC channel.
- Fetches every feed in a separate thread
- Posts new news items to an IRC channel
- Sends information via private messages
- Full utf-8 support
- Nick login support
- Post delayed during conversation
- Keywords in news title filtering support
- Customizable post colors
- Automatic join to channel on kick

# Bot's commands:

Expand Down
145 changes: 98 additions & 47 deletions bot.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#!/usr/bin/env python
#!/usr/bin/env python2
# -*- coding: utf-8 -*-

import ssl
Expand All @@ -9,6 +9,7 @@
import tinyurl
import time
import re
import sys
import feedparser
import datetime
import dateutil.parser
Expand All @@ -17,6 +18,7 @@
from config import Config
from feedupdater import FeedUpdater


class IRCBot(irc.bot.SingleServerIRCBot):
def __init__(self, config, db, on_connect_cb):
self.__config = config
Expand All @@ -25,44 +27,59 @@ def __init__(self, config, db, on_connect_cb):
self.__servers = [irc.bot.ServerSpec(self.__config.HOST, self.__config.PORT, self.__config.PASSWORD)]
self.__first_start = False
self.color_num = self.__config.num_col
self.color_date = self.__config.date
self.color_feedname = self.__config.feedname
self.color_newstitle = self.__config.newstitle
self.color_url = self.__config.url
self.color_date = self.__config.date
self.shorturls = self.__config.shorturls
self.dateformat = self.__config.dateformat
self.filterkeywords = self.__config.filterkeywords

if self.__config.SSL:
ssl_factory = irc.connection.Factory(wrapper=ssl.wrap_socket)
print datetime.datetime.now(), u"Starting SSL connection."
sys.stdout.flush()
super(IRCBot, self).__init__(self.__servers, self.__config.NICK, self.__config.NICK, connect_factory=ssl_factory)

else:
print datetime.datetime.now(), u"Starting connection."
sys.stdout.flush()
super(IRCBot, self).__init__(self.__servers, self.__config.NICK, self.__config.NICK)

def on_kick(self, connection, event):
"""Join the correct channel again"""
if irc.client.is_channel(self.__config.CHANNEL):
time.sleep(31)
connection.join(self.__config.CHANNEL)

def on_welcome(self, connection, event):
"""Authenticate using NickServ"""
"""Login"""
if self.__config.NICKPASS:
self.connection.privmsg("NickServ", "IDENTIFY {}".format(self.__config.NICKPASS))
print datetime.datetime.now(), u"Starting authentication."
sys.stdout.flush()
self.send_msg("NickServ", "IDENTIFY {}".format(self.__config.NICKPASS))

"""Join the correct channel upon connecting"""
if irc.client.is_channel(self.__config.CHANNEL):
print datetime.datetime.now(), u"Joining to channel."
sys.stdout.flush()
connection.join(self.__config.CHANNEL)

def on_join(self, connection, event):
"""Say hello to other people in the channel. """
welcome_msg = "Hi, I'm " + self.__get_colored_text('3',str(connection.get_nickname())) + " your bot. Send " + self.__get_colored_text(self.color_num,"!help") +" to get a list of commands."

if not self.__first_start:
connection.privmsg(self.__config.CHANNEL, welcome_msg)
self.send_msg(self.__config.CHANNEL, self.welcome_msg())
self.__on_connect_cb()
self.__first_start = True

if event.source.nick != connection.get_nickname():
connection.privmsg(event.source.nick, welcome_msg)
def welcome_msg(self):
msg = u"Hi, I'm the channel's " + self.get_bolded_text(self.__get_colored_text(self.color_feedname,"RSS")) + u" news publishing bot v2.0. Send " + self.__get_colored_text(self.color_num,"!help") + u" to receive a list of commands in private message (PM). If you find me annoying, you can to use " + self.__get_colored_text(self.color_num,"/IGNORE " + self.connection.get_nickname()) + u" to stop reading me."
time.sleep(1)
return msg

def on_kick(self, connection, event):
"""Join the correct channel again"""
banned_nick = event.arguments[0].lower().strip()
botnick = self.connection.get_nickname().lower()
if irc.client.is_channel(self.__config.CHANNEL) and banned_nick == botnick:
time.sleep(31)
print datetime.datetime.now(), u"Joining to channel again."
sys.stdout.flush()
connection.join(self.__config.CHANNEL)

def __handle_msg(self, msg):
"""Handles a cmd private message."""
Expand All @@ -75,13 +92,13 @@ def __handle_msg(self, msg):
elif msg == "!list":
answer = ""
for entry in self.__db.get_feeds():
answer += "#" + self.__get_colored_text(self.color_num,str(entry[0])) + ": " + entry[1] + ", " + self.__get_colored_text(self.color_url,str(entry[2])) + self.__get_colored_text(self.color_date,", updated every ") + self.__get_colored_text(self.color_num,str(entry[3])) + self.__get_colored_text(self.color_date," min") + "\n"
answer += "#" + self.__get_colored_text(self.color_num,str(entry[0]) + " - ") + self.get_bolded_text(self.__get_colored_text(self.color_feedname,entry[1] + " > ")) + self.__get_colored_text(self.color_url,entry[2] + ",") + u" updated every " + self.__get_colored_text(self.color_num,str(entry[3])) + u" minutes." + "\n"

# Print some simple stats (Feed / News count)
elif msg == "!stats":
feeds_count = self.__db.get_feeds_count()
news_count = self.__db.get_news_count()
answer = "Feeds: " + self.__get_colored_text(self.color_num,str(feeds_count)) + ", News: " + self.__get_colored_text(self.color_num,str(news_count))
answer = u"Feeds: " + self.get_bolded_text(self.__get_colored_text(self.color_num,str(feeds_count))) + u", News: " + self.get_bolded_text(self.__get_colored_text(self.color_num,str(news_count)))

# Print last config.feedlimit news.
elif msg == "!last":
Expand All @@ -91,28 +108,28 @@ def __handle_msg(self, msg):
items = items[::-1]

for entry in items:
answer += "#" + self.__get_colored_text(self.color_num,str(entry[0])) + ": " + entry[1] + ", " + self.__get_colored_text(self.color_url,str(entry[2])) + ", " + self.__get_colored_text(self.color_date,str(entry[3])) + "\n"
answer += "#" + self.__get_colored_text(self.color_num,str(entry[0]) + " - ") + self.get_bolded_text(self.__get_colored_text(self.color_newstitle,entry[1] + " > ")) + self.__get_colored_text(self.color_url,entry[2] + ", ") + self.__get_colored_text(self.color_date,str(entry[3])) + "\n"

# Print last config.feedlimit news for a specific feed
elif msg.startswith("!lastfeed"):
answer = ""
try:
feedid = int(msg.replace("!lastfeed","").strip())
except:
return self.__get_colored_text('1',"Wrong command: ") + msg + ", use: !lastfeed <feedid>"
return self.__get_colored_text('1',u"Wrong command. ") + msg + u". Send !lastfeed <feedid>"
items = self.__db.get_news_from_feed(feedid, self.__config.feedlimit)
if not self.__config.feedorderdesc:
items = items[::-1]
for entry in items:
answer += "#" + self.__get_colored_text(self.color_num,str(entry[0])) + ": " + entry[1] + ", " + self.__get_colored_text(self.color_url,str(entry[2])) + ", " + self.__get_colored_text(self.color_date,str(entry[3])) + "\n"
answer += "#" + self.__get_colored_text(self.color_num,str(entry[0]) + " - ") + self.get_bolded_text(self.__get_colored_text(self.color_newstitle,entry[1] + " > ")) + self.__get_colored_text(self.color_url,entry[2] + ", ") + self.__get_colored_text(self.color_date,str(entry[3])) + "\n"

# Else tell the user how to use the bot
else:
answer = "Use !help for possible commands."
answer = u"Send !help to see the available commands."
except Exception as e:
print e
answer = "Something went wrong :("

print datetime.datetime.now(), e
sys.stdout.flush()
answer = u"Something was wrong."
return answer

def on_privmsg(self, connection, event):
Expand All @@ -122,22 +139,26 @@ def on_privmsg(self, connection, event):

# Get the message and return an answer
msg = event.arguments[0].lower().strip()
print msg

print datetime.datetime.now(), msg, "command from", event.source.nick
sys.stdout.flush()
answer = self.__handle_msg(msg)
self.send_msg(event.source.nick, answer)
time.sleep(5)

def on_pubmsg(self, connection, event):
Config.lastpubmsg = time.time()
"""Handles the bot's public (channel) messages"""
if len(event.arguments) < 1:
return

# Get the message. We are only interested in "!help"
# Get the message. We are only interested in "!help" or botnick
msg = event.arguments[0].lower().strip()

botnick = self.connection.get_nickname()
# Send the answer as a private message
if msg == "!help":
self.send_msg(event.source.nick, self.__help_msg())
# Send the answer as a public message
if botnick.lower() in msg:
self.send_msg(self.__config.CHANNEL, self.welcome_msg())

def on_nicknameinuse(self, connection, event):
"""Changes the nickname if necessary"""
Expand All @@ -153,34 +174,61 @@ def send_msg(self, target, msg):
self.connection.privmsg(target, sub_line)
time.sleep(1) # Don't flood the target
except Exception as e:
print e
print datetime.datetime.now(), e
sys.stdout.flush()

def post_news(self, feed_name, title, url, date):
"""Cancel post if filter keyword is in title"""
for keyword in self.filterkeywords:
if keyword in title.lower():
print datetime.datetime.now(), u"Found", keyword, "keyword in title. Aborting post."
sys.stdout.flush()
return
"""Try shortening url"""
if self.__config.shorturls:
try:
post_url = tinyurl.create_one(url)
if ("error" in post_url.lower()):
post_url = url
except Exception as e:
post_url = url
print datetime.datetime.now(), e
sys.stdout.flush()
else:
post_url = url
"""Posts a new announcement to the channel"""
try:
msg = self.__get_colored_text(self.color_feedname,str(feed_name)) + ": " + title + ", " + self.__get_colored_text(self.color_url,url) + ", " + self.__get_colored_text(self.color_date,str(date))
msg = self.__get_colored_text(self.color_feedname,feed_name + ": ") + self.get_bolded_text(self.__get_colored_text(self.color_newstitle,title)) + " > " + self.__get_colored_text(self.color_url,post_url + ", ") + self.__get_colored_text(self.color_date,str(date))
self.send_msg(self.__config.CHANNEL, msg)
except Exception as e:
print e
print datetime.datetime.now(), e
sys.stdout.flush()

def __get_colored_text(self, color, text):
if not self.__config.use_colors:
return text

return Colours(color, text).get()

def get_bolded_text(self, string):
"""Returns the string bolded."""
return "\002" + string + "\002"

def __help_msg(self):
"""Returns the help/usage message"""
return """\
return u"""\
Help:
Send all commands as a private message to """ + self.connection.get_nickname() + """
- !help Prints this help
- !list Prints all feeds
- !stats Prints some statistics
- !last Prints the last 10 entries
- !lastfeed <feedid> Prints the last 10 entries from a specific feed
- /IGNORE """ + self.connection.get_nickname() + u""" - Lets you stop reading the bot.

You can send these commands in private message (PM) to """ + self.connection.get_nickname() + u""":
- !help - Show this help message.
- !stats - Show some statistics.
- !list - Show all feeds.
- !last - Show last news published in all feeds.
- !lastfeed <feedid> - Show last news published in a specific feed.
"""


class Bot(object):
def __init__(self):
self.__config = Config()
Expand All @@ -193,9 +241,9 @@ def __init__(self):
self.__connected = False

def __check_config(self):
necessary_options = ["HOST", "PORT", "PASSWORD", "SSL", "CHANNEL", "NICK", "admin_nicks", "use_colors",
"num_col", "date", "feedname", "shorturls", "dateformat", "feedlimit", "update_before_connecting",
"url", "feedorderdesc"]
necessary_options = ["HOST", "PORT", "PASSWORD", "SSL", "CHANNEL", "NICK", "admin_nicks", "use_colors",
"num_col", "date", "feedname", "shorturls", "dateformat", "feedlimit", "update_before_connecting",
"url", "feedorderdesc"]
missing_options = []
for key in necessary_options:
if not hasattr(self.__config, key):
Expand All @@ -207,21 +255,24 @@ def get_missing_options(self):

def start(self):
"""Starts the IRC bot"""
print datetime.datetime.now(), u"Starting bot."
sys.stdout.flush()
threading.Thread(target=self.__irc.start).start()

def initial_feed_update(self):
def print_feed_update(feed_title, news_title, news_url, news_date):
print(u"[+]: {}||{}||{}||{}".format(feed_title, news_title, news_url, news_date))
print datetime.datetime.now(), u"[+]: {}||{}||{}||{}".format(feed_title, news_title, news_url, news_date)
sys.stdout.flush()

if self.__config.update_before_connecting:
print "Started pre-connection updates!"
print datetime.datetime.now(), u"Starting offline update."
sys.stdout.flush()
self.__feedupdater.update_feeds(print_feed_update, False)
print "DONE!"

def on_started(self):
"""Gets executed after the IRC thread has successfully established a connection."""
if not self.__connected:
print "Connected!"
print datetime.datetime.now(), u"Starting feeds periodic update..."
sys.stdout.flush()
self.__feedupdater.update_feeds(self.__irc.post_news, True)
print "Started feed updates!"
self.__connected = True
62 changes: 38 additions & 24 deletions colour.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,37 +1,51 @@
#!/usr/bin/env python2
# -*- coding: utf-8 -*-

class Colours:
def __init__(self, col, string):
self.colour = col
self.string = string
self.default = '\017'
self.ret = self.string+self.default
self.default = '\003'
self.ret = self.string + self.default

def get(self):
if self.colour == '1' or self.colour == 'red':
return '\00304'+self.ret
elif self.colour == '2' or self.colour == 'green':
return '\00303'+self.ret
elif self.colour == '3' or self.colour == 'yellow':
return '\00308'+self.ret
elif self.colour == '4' or self.colour == 'blue':
return '\00312'+self.ret
elif self.colour == '5' or self.colour == 'purple':
return '\00306'+self.ret
elif self.colour == '6' or self.colour == 'cyan':
return '\00310'+self.ret
elif self.colour == '7' or self.colour == 'lightgreen':
return '\00309'+self.ret
elif self.colour == '8' or self.colour == 'grey':
return '\00314'+self.ret
elif self.colour == '9' or self.colour == 'pink':
return '\00313'+self.ret
elif self.colour == '10' or self.colour == 'lightblue':
return '\00311'+self.ret
if self.colour == '0' or self.colour == 'white':
return '\00300' + self.ret
elif self.colour == '1' or self.colour == 'black':
return '\00301' + self.ret
elif self.colour == '2' or self.colour == 'blue':
return '\00302' + self.ret
elif self.colour == '3' or self.colour == 'green':
return '\00303' + self.ret
elif self.colour == '4' or self.colour == 'red':
return '\00304' + self.ret
elif self.colour == '5' or self.colour == 'brown':
return '\00305' + self.ret
elif self.colour == '6' or self.colour == 'purple':
return '\00306' + self.ret
elif self.colour == '7' or self.colour == 'orange':
return '\00307' + self.ret
elif self.colour == '8' or self.colour == 'yellow':
return '\00308' + self.ret
elif self.colour == '9' or self.colour == 'lightgreen':
return '\00309' + self.ret
elif self.colour == '10' or self.colour == 'teal':
return '\00310' + self.ret
elif self.colour == '11' or self.colour == 'cyan':
return '\00311' + self.ret
elif self.colour == '12' or self.colour == 'lightblue':
return '\00312' + self.ret
elif self.colour == '13' or self.colour == 'pink':
return '\00313' + self.ret
elif self.colour == '14' or self.colour == 'grey':
return '\00314' + self.ret
elif self.colour == '15' or self.colour == 'lightgrey':
return '\00315' + self.ret
else:
return '\00316'+self.ret
return self.string

"""
if __name__ == "__main__":
for i in range(0, 11):
print Colours(str(i), 'Testing').get() + "TESTING "+Colours(str(i), 'wat').get()
print Colours(str(i), 'Testing').get() + "TESTING " + Colours(str(i), 'wat').get()
"""
Loading