Spaces to tabs (cause fuck you) and fixed nickserv line missing f-string
This commit is contained in:
parent
4e675ed26e
commit
0df93b8f80
GPG Key ID:
EF4B922DB85DC9DE
342
skeleton.py
342
skeleton.py
@ -35,200 +35,200 @@ grey = '14'
|
||||
light_grey = '15'
|
||||
|
||||
def color(msg: str, foreground: str, background: str = None) -> str:
|
||||
'''
|
||||
Color a string with the specified foreground and background colors.
|
||||
'''
|
||||
Color a string with the specified foreground and background colors.
|
||||
|
||||
:param msg: The string to color.
|
||||
:param foreground: The foreground color to use.
|
||||
:param background: The background color to use.
|
||||
'''
|
||||
return f'\x03{foreground},{background}{msg}{reset}' if background else f'\x03{foreground}{msg}{reset}'
|
||||
:param msg: The string to color.
|
||||
:param foreground: The foreground color to use.
|
||||
:param background: The background color to use.
|
||||
'''
|
||||
return f'\x03{foreground},{background}{msg}{reset}' if background else f'\x03{foreground}{msg}{reset}'
|
||||
|
||||
def ssl_ctx(verify: bool = False, cert_path: str = None, cert_pass: str = None) -> ssl.SSLContext:
|
||||
'''
|
||||
Create a SSL context for the connection.
|
||||
|
||||
:param verify: Verify the SSL certificate.
|
||||
:param cert_path: The path to the SSL certificate.
|
||||
:param cert_pass: The password for the SSL certificate.
|
||||
'''
|
||||
ctx = ssl.create_default_context() if verify else ssl._create_unverified_context()
|
||||
if cert_path:
|
||||
ctx.load_cert_chain(cert_path) if not cert_pass else ctx.load_cert_chain(cert_path, cert_pass)
|
||||
return ctx
|
||||
'''
|
||||
Create a SSL context for the connection.
|
||||
|
||||
:param verify: Verify the SSL certificate.
|
||||
:param cert_path: The path to the SSL certificate.
|
||||
:param cert_pass: The password for the SSL certificate.
|
||||
'''
|
||||
ctx = ssl.create_default_context() if verify else ssl._create_unverified_context()
|
||||
if cert_path:
|
||||
ctx.load_cert_chain(cert_path) if not cert_pass else ctx.load_cert_chain(cert_path, cert_pass)
|
||||
return ctx
|
||||
|
||||
class Bot():
|
||||
def __init__(self):
|
||||
self.nickname = 'skeleton'
|
||||
self.username = 'skelly'
|
||||
self.realname = 'Developement Bot'
|
||||
self.reader = None
|
||||
self.writer = None
|
||||
self.last = time.time()
|
||||
def __init__(self):
|
||||
self.nickname = 'skeleton'
|
||||
self.username = 'skelly'
|
||||
self.realname = 'Developement Bot'
|
||||
self.reader = None
|
||||
self.writer = None
|
||||
self.last = time.time()
|
||||
|
||||
async def action(self, chan: str, msg: str):
|
||||
'''
|
||||
Send an ACTION to the IRC server.
|
||||
async def action(self, chan: str, msg: str):
|
||||
'''
|
||||
Send an ACTION to the IRC server.
|
||||
|
||||
:param chan: The channel to send the ACTION to.
|
||||
:param msg: The message to send to the channel.
|
||||
'''
|
||||
await self.sendmsg(chan, f'\x01ACTION {msg}\x01')
|
||||
:param chan: The channel to send the ACTION to.
|
||||
:param msg: The message to send to the channel.
|
||||
'''
|
||||
await self.sendmsg(chan, f'\x01ACTION {msg}\x01')
|
||||
|
||||
async def raw(self, data: str):
|
||||
'''
|
||||
Send raw data to the IRC server.
|
||||
async def raw(self, data: str):
|
||||
'''
|
||||
Send raw data to the IRC server.
|
||||
|
||||
:param data: The raw data to send to the IRC server. (512 bytes max including crlf)
|
||||
'''
|
||||
self.writer.write(data[:510].encode('utf-8') + b'\r\n')
|
||||
:param data: The raw data to send to the IRC server. (512 bytes max including crlf)
|
||||
'''
|
||||
self.writer.write(data[:510].encode('utf-8') + b'\r\n')
|
||||
|
||||
async def sendmsg(self, target: str, msg: str):
|
||||
'''
|
||||
Send a PRIVMSG to the IRC server.
|
||||
async def sendmsg(self, target: str, msg: str):
|
||||
'''
|
||||
Send a PRIVMSG to the IRC server.
|
||||
|
||||
:param target: The target to send the PRIVMSG to. (channel or user)
|
||||
:param msg: The message to send to the target.
|
||||
'''
|
||||
await self.raw(f'PRIVMSG {target} :{msg}')
|
||||
:param target: The target to send the PRIVMSG to. (channel or user)
|
||||
:param msg: The message to send to the target.
|
||||
'''
|
||||
await self.raw(f'PRIVMSG {target} :{msg}')
|
||||
|
||||
async def connect(self):
|
||||
'''Connect to the IRC server.'''
|
||||
while True:
|
||||
try:
|
||||
options = {
|
||||
'host' : args.server,
|
||||
'port' : args.port if args.port else 6697 if args.ssl else 6667,
|
||||
'limit' : 1024, # Buffer size in bytes (don't change this unless you know what you're doing)
|
||||
'ssl' : ssl_ctx() if args.ssl else None,
|
||||
'family' : 10 if args.v6 else 2, # 10 = AF_INET6 (IPv6), 2 = AF_INET (IPv4)
|
||||
'local_addr' : args.vhost if args.vhost else None # Can we just leave this as args.vhost?
|
||||
}
|
||||
self.reader, self.writer = await asyncio.wait_for(asyncio.open_connection(**options), 15) # 15 second timeout
|
||||
if args.password:
|
||||
await self.raw('PASS ' + args.password) # Rarely used, but IRCds may require this
|
||||
await self.raw(f'USER {self.username} 0 * :{self.realname}') # These lines must be sent upon connection
|
||||
await self.raw('NICK ' + self.nickname) # They are to identify the bot to the server
|
||||
while not self.reader.at_eof():
|
||||
data = await asyncio.wait_for(self.reader.readuntil(b'\r\n'), 300) # 5 minute ping timeout
|
||||
await self.handle(data.decode('utf-8').strip()) # Handle the data received from the IRC server
|
||||
except Exception as ex:
|
||||
logging.error(f'failed to connect to {args.server} ({str(ex)})')
|
||||
finally:
|
||||
await asyncio.sleep(30) # Wait 30 seconds before reconnecting
|
||||
async def connect(self):
|
||||
'''Connect to the IRC server.'''
|
||||
while True:
|
||||
try:
|
||||
options = {
|
||||
'host' : args.server,
|
||||
'port' : args.port if args.port else 6697 if args.ssl else 6667,
|
||||
'limit' : 1024, # Buffer size in bytes (don't change this unless you know what you're doing)
|
||||
'ssl' : ssl_ctx() if args.ssl else None,
|
||||
'family' : 10 if args.v6 else 2, # 10 = AF_INET6 (IPv6), 2 = AF_INET (IPv4)
|
||||
'local_addr' : args.vhost if args.vhost else None # Can we just leave this as args.vhost?
|
||||
}
|
||||
self.reader, self.writer = await asyncio.wait_for(asyncio.open_connection(**options), 15) # 15 second timeout
|
||||
if args.password:
|
||||
await self.raw('PASS ' + args.password) # Rarely used, but IRCds may require this
|
||||
await self.raw(f'USER {self.username} 0 * :{self.realname}') # These lines must be sent upon connection
|
||||
await self.raw('NICK ' + self.nickname) # They are to identify the bot to the server
|
||||
while not self.reader.at_eof():
|
||||
data = await asyncio.wait_for(self.reader.readuntil(b'\r\n'), 300) # 5 minute ping timeout
|
||||
await self.handle(data.decode('utf-8').strip()) # Handle the data received from the IRC server
|
||||
except Exception as ex:
|
||||
logging.error(f'failed to connect to {args.server} ({str(ex)})')
|
||||
finally:
|
||||
await asyncio.sleep(30) # Wait 30 seconds before reconnecting
|
||||
|
||||
async def eventPRIVMSG(self, data: str):
|
||||
'''
|
||||
Handle the PRIVMSG event.
|
||||
async def eventPRIVMSG(self, data: str):
|
||||
'''
|
||||
Handle the PRIVMSG event.
|
||||
|
||||
:param data: The data received from the IRC server.
|
||||
'''
|
||||
parts = data.split()
|
||||
ident = parts[0][1:] # nick!user@host
|
||||
nick = parts[0].split('!')[0][1:] # Nickname of the user who sent the message
|
||||
target = parts[2] # Channel or user (us) the message was sent to
|
||||
msg = ' '.join(parts[3:])[1:]
|
||||
if target == self.nickname: # Handle private messages
|
||||
if ident == 'acidvegas!stillfree@big.dick.acid.vegas': # Admin only command based on ident
|
||||
if msg.startswith('!raw') and len(msg.split()) > 1: # Only allow !raw if there is some data
|
||||
option = ' '.join(msg.split()[1:]) # Everything after !raw is stored here
|
||||
await self.raw(option) # Send raw data to the server FROM the bot
|
||||
else:
|
||||
await self.sendmsg(nick, 'Do NOT message me!') # Let's ignore anyone PM'ing the bot that isn't the admin
|
||||
if target.startswith('#'): # Handle channel messages
|
||||
if msg.startswith('!'):
|
||||
if time.time() - self.last < cmd_flood: # Prevent command flooding
|
||||
if not self.slow: # The self.slow variable is used so that a warning is only issued one time
|
||||
self.slow = True
|
||||
await self.sendmsg(target, color('Slow down nerd!', red))
|
||||
else: # Once we confirm the user isn't command flooding, we can handle the commands
|
||||
self.slow = False
|
||||
if msg == '!help':
|
||||
await self.action(target, 'explodes')
|
||||
elif msg == '!ping':
|
||||
await self.sendmsg(target, 'Pong!')
|
||||
elif msg.startswith('!say') and len(msg.split()) > 1: # Only allow !say if there is something to say
|
||||
option = ' '.join(msg.split()[1:]) # Everything after !say is stored here
|
||||
await self.sendmsg(target, option)
|
||||
self.last = time.time() # Update the last command time if it starts with ! character to prevent command flooding
|
||||
:param data: The data received from the IRC server.
|
||||
'''
|
||||
parts = data.split()
|
||||
ident = parts[0][1:] # nick!user@host
|
||||
nick = parts[0].split('!')[0][1:] # Nickname of the user who sent the message
|
||||
target = parts[2] # Channel or user (us) the message was sent to
|
||||
msg = ' '.join(parts[3:])[1:]
|
||||
if target == self.nickname: # Handle private messages
|
||||
if ident == 'acidvegas!stillfree@big.dick.acid.vegas': # Admin only command based on ident
|
||||
if msg.startswith('!raw') and len(msg.split()) > 1: # Only allow !raw if there is some data
|
||||
option = ' '.join(msg.split()[1:]) # Everything after !raw is stored here
|
||||
await self.raw(option) # Send raw data to the server FROM the bot
|
||||
else:
|
||||
await self.sendmsg(nick, 'Do NOT message me!') # Let's ignore anyone PM'ing the bot that isn't the admin
|
||||
if target.startswith('#'): # Handle channel messages
|
||||
if msg.startswith('!'):
|
||||
if time.time() - self.last < cmd_flood: # Prevent command flooding
|
||||
if not self.slow: # The self.slow variable is used so that a warning is only issued one time
|
||||
self.slow = True
|
||||
await self.sendmsg(target, color('Slow down nerd!', red))
|
||||
else: # Once we confirm the user isn't command flooding, we can handle the commands
|
||||
self.slow = False
|
||||
if msg == '!help':
|
||||
await self.action(target, 'explodes')
|
||||
elif msg == '!ping':
|
||||
await self.sendmsg(target, 'Pong!')
|
||||
elif msg.startswith('!say') and len(msg.split()) > 1: # Only allow !say if there is something to say
|
||||
option = ' '.join(msg.split()[1:]) # Everything after !say is stored here
|
||||
await self.sendmsg(target, option)
|
||||
self.last = time.time() # Update the last command time if it starts with ! character to prevent command flooding
|
||||
|
||||
async def handle(self, data: str):
|
||||
'''
|
||||
Handle the data received from the IRC server.
|
||||
async def handle(self, data: str):
|
||||
'''
|
||||
Handle the data received from the IRC server.
|
||||
|
||||
:param data: The data received from the IRC server.
|
||||
'''
|
||||
logging.info(data)
|
||||
try:
|
||||
parts = data.split()
|
||||
if data.startswith('ERROR :Closing Link:'):
|
||||
raise Exception('BANNED')
|
||||
if parts[0] == 'PING':
|
||||
await self.raw('PONG ' + parts[1]) # Respond to the server's PING request with a PONG to prevent ping timeout
|
||||
elif parts[1] == '001': # RPL_WELCOME
|
||||
await self.raw(f'MODE {self.nickname} +B') # Set user mode +B (Bot)
|
||||
await self.sendmsg('NickServ', 'IDENTIFY {self.nickname} simps0nsfan420') # Identify to NickServ
|
||||
await self.raw('OPER MrSysadmin fartsimps0n1337') # Oper up
|
||||
await asyncio.sleep(10) # Wait 10 seconds before joining the channel (required by some IRCds to wait before JOIN)
|
||||
if parts.key:
|
||||
await self.raw(f'JOIN {args.channel} {args.key}') # Join the channel with the key
|
||||
else:
|
||||
await self.raw(f'JOIN {args.channel}')
|
||||
elif parts[1] == '433': # ERR_NICKNAMEINUSE
|
||||
self.nickname += '_' # If the nickname is already in use, append an underscore to the end of it
|
||||
await self.raw('NICK ' + self.nickname) # Send the new nickname to the server
|
||||
elif parts[1] == 'INVITE':
|
||||
target = parts[2]
|
||||
chan = parts[3][1:]
|
||||
if target == self.nickname: # If we were invited to a channel, join it
|
||||
await self.raw(f'JOIN {chan}')
|
||||
elif parts[1] == 'KICK':
|
||||
chan = parts[2]
|
||||
kicked = parts[3]
|
||||
if kicked == self.nickname: # If we were kicked from the channel, rejoin it after 3 seconds
|
||||
await asyncio.sleep(3)
|
||||
await self.raw(f'JOIN {chan}')
|
||||
elif parts[1] == 'PRIVMSG':
|
||||
await self.eventPRIVMSG(data) # We put this in a separate function since it will likely be the most used/handled event
|
||||
except (UnicodeDecodeError, UnicodeEncodeError):
|
||||
pass # Some IRCds allow invalid UTF-8 characters, this is a very important exception to catch
|
||||
except Exception as ex:
|
||||
logging.exception(f'Unknown error has occured! ({ex})')
|
||||
:param data: The data received from the IRC server.
|
||||
'''
|
||||
logging.info(data)
|
||||
try:
|
||||
parts = data.split()
|
||||
if data.startswith('ERROR :Closing Link:'):
|
||||
raise Exception('BANNED')
|
||||
if parts[0] == 'PING':
|
||||
await self.raw('PONG ' + parts[1]) # Respond to the server's PING request with a PONG to prevent ping timeout
|
||||
elif parts[1] == '001': # RPL_WELCOME
|
||||
await self.raw(f'MODE {self.nickname} +B') # Set user mode +B (Bot)
|
||||
await self.sendmsg('NickServ', f'IDENTIFY {self.nickname} simps0nsfan420') # Identify to NickServ
|
||||
await self.raw('OPER MrSysadmin fartsimps0n1337') # Oper up
|
||||
await asyncio.sleep(10) # Wait 10 seconds before joining the channel (required by some IRCds to wait before JOIN)
|
||||
if parts.key:
|
||||
await self.raw(f'JOIN {args.channel} {args.key}') # Join the channel with the key
|
||||
else:
|
||||
await self.raw(f'JOIN {args.channel}')
|
||||
elif parts[1] == '433': # ERR_NICKNAMEINUSE
|
||||
self.nickname += '_' # If the nickname is already in use, append an underscore to the end of it
|
||||
await self.raw('NICK ' + self.nickname) # Send the new nickname to the server
|
||||
elif parts[1] == 'INVITE':
|
||||
target = parts[2]
|
||||
chan = parts[3][1:]
|
||||
if target == self.nickname: # If we were invited to a channel, join it
|
||||
await self.raw(f'JOIN {chan}')
|
||||
elif parts[1] == 'KICK':
|
||||
chan = parts[2]
|
||||
kicked = parts[3]
|
||||
if kicked == self.nickname: # If we were kicked from the channel, rejoin it after 3 seconds
|
||||
await asyncio.sleep(3)
|
||||
await self.raw(f'JOIN {chan}')
|
||||
elif parts[1] == 'PRIVMSG':
|
||||
await self.eventPRIVMSG(data) # We put this in a separate function since it will likely be the most used/handled event
|
||||
except (UnicodeDecodeError, UnicodeEncodeError):
|
||||
pass # Some IRCds allow invalid UTF-8 characters, this is a very important exception to catch
|
||||
except Exception as ex:
|
||||
logging.exception(f'Unknown error has occured! ({ex})')
|
||||
|
||||
|
||||
def setup_logger(log_filename: str, to_file: bool = False):
|
||||
'''
|
||||
Set up logging to console & optionally to file.
|
||||
'''
|
||||
Set up logging to console & optionally to file.
|
||||
|
||||
:param log_filename: The filename of the log file
|
||||
:param to_file: Whether or not to log to a file
|
||||
'''
|
||||
sh = logging.StreamHandler()
|
||||
sh.setFormatter(logging.Formatter('%(asctime)s | %(levelname)9s | %(message)s', '%I:%M %p'))
|
||||
if to_file:
|
||||
fh = logging.handlers.RotatingFileHandler(log_filename+'.log', maxBytes=250000, backupCount=3, encoding='utf-8') # Max size of 250KB, 3 backups
|
||||
fh.setFormatter(logging.Formatter('%(asctime)s | %(levelname)9s | %(filename)s.%(funcName)s.%(lineno)d | %(message)s', '%Y-%m-%d %I:%M %p')) # We can be more verbose in the log file
|
||||
logging.basicConfig(level=logging.NOTSET, handlers=(sh,fh))
|
||||
else:
|
||||
logging.basicConfig(level=logging.NOTSET, handlers=(sh,))
|
||||
:param log_filename: The filename of the log file
|
||||
:param to_file: Whether or not to log to a file
|
||||
'''
|
||||
sh = logging.StreamHandler()
|
||||
sh.setFormatter(logging.Formatter('%(asctime)s | %(levelname)9s | %(message)s', '%I:%M %p'))
|
||||
if to_file:
|
||||
fh = logging.handlers.RotatingFileHandler(log_filename+'.log', maxBytes=250000, backupCount=3, encoding='utf-8') # Max size of 250KB, 3 backups
|
||||
fh.setFormatter(logging.Formatter('%(asctime)s | %(levelname)9s | %(filename)s.%(funcName)s.%(lineno)d | %(message)s', '%Y-%m-%d %I:%M %p')) # We can be more verbose in the log file
|
||||
logging.basicConfig(level=logging.NOTSET, handlers=(sh,fh))
|
||||
else:
|
||||
logging.basicConfig(level=logging.NOTSET, handlers=(sh,))
|
||||
|
||||
if __name__ == '__main__':
|
||||
parser = argparse.ArgumentParser(description="Connect to an IRC server.") # The arguments without -- are required arguments.
|
||||
parser.add_argument("server", help="The IRC server address.")
|
||||
parser.add_argument("channel", help="The IRC channel to join.")
|
||||
parser.add_argument("--password", help="The password for the IRC server.")
|
||||
parser.add_argument("--port", type=int, help="The port number for the IRC server.") # Port is optional, will default to 6667/6697 depending on SSL.
|
||||
parser.add_argument("--ssl", action="store_true", help="Use SSL for the connection.")
|
||||
parser.add_argument("--v4", action="store_true", help="Use IPv4 for the connection.")
|
||||
parser.add_argument("--v6", action="store_true", help="Use IPv6 for the connection.")
|
||||
parser.add_argument("--key", default="", help="The key (password) for the IRC channel, if required.")
|
||||
parser.add_argument("--vhost", help="The VHOST to use for connection.")
|
||||
args = parser.parse_args()
|
||||
parser = argparse.ArgumentParser(description="Connect to an IRC server.") # The arguments without -- are required arguments.
|
||||
parser.add_argument("server", help="The IRC server address.")
|
||||
parser.add_argument("channel", help="The IRC channel to join.")
|
||||
parser.add_argument("--password", help="The password for the IRC server.")
|
||||
parser.add_argument("--port", type=int, help="The port number for the IRC server.") # Port is optional, will default to 6667/6697 depending on SSL.
|
||||
parser.add_argument("--ssl", action="store_true", help="Use SSL for the connection.")
|
||||
parser.add_argument("--v4", action="store_true", help="Use IPv4 for the connection.")
|
||||
parser.add_argument("--v6", action="store_true", help="Use IPv6 for the connection.")
|
||||
parser.add_argument("--key", default="", help="The key (password) for the IRC channel, if required.")
|
||||
parser.add_argument("--vhost", help="The VHOST to use for connection.")
|
||||
args = parser.parse_args()
|
||||
|
||||
print(f"Connecting to {args.server}:{args.port} (SSL: {args.ssl}) and joining {args.channel} (Key: {args.key or 'None'})")
|
||||
print(f"Connecting to {args.server}:{args.port} (SSL: {args.ssl}) and joining {args.channel} (Key: {args.key or 'None'})")
|
||||
|
||||
setup_logger('skeleton', to_file=True) # Optionally, you can log to a file, change to_file to False to disable this.
|
||||
setup_logger('skeleton', to_file=True) # Optionally, you can log to a file, change to_file to False to disable this.
|
||||
|
||||
bot = Bot() # We define this here as an object so we can call it from an outside function if we need to.
|
||||
bot = Bot() # We define this here as an object so we can call it from an outside function if we need to.
|
||||
|
||||
asyncio.run(bot.connect())
|
||||
asyncio.run(bot.connect())
|
||||
|
||||
Loading…
Reference in New Issue
Block a user