net-tools.py

#! /usr/bin/python3

# by FvH, released under Apache License v2.0

# either install 'python3-paho-mqtt' or 'pip3 install paho-mqtt'

# ping3 from pip
# ntplib from pip

import ntplib
import paho.mqtt.client as mqtt
from ping3 import ping
import threading
import socket
import sys
import time

mqtt_server  = 'mqtt.vm.nurd.space'
topic_prefix = 'GHBot/'
channels     = ['nurdbottest', 'nurds', 'test']
prefix       = '!'

def announce_commands(client):
    target_topic = f'{topic_prefix}to/bot/register'

    client.publish(target_topic, 'cmd=ping|descr=Perform ping (ICMP request) on $parameter.')
    client.publish(target_topic, 'cmd=time|descr=What point on the vector of time are we right now.')

def on_message(client, userdata, message):
    global prefix

    text = message.payload.decode('utf-8')

    topic = message.topic[len(topic_prefix):]

    if topic == 'from/bot/command' and text == 'register':
        announce_commands(client)

        return

    if topic == 'from/bot/parameter/prefix':
        prefix = text

        return

    if text[0] != prefix:
        return

    parts   = topic.split('/')
    channel = parts[2] if len(parts) >= 3 else 'nurds'
    nick    = parts[3] if len(parts) >= 4 else 'jemoeder'

    if channel in channels or (len(channel) >= 1 and channel[0] == '\\'):
        tokens  = text.split(' ')

        command = tokens[0][1:]

        response_topic = f'{topic_prefix}to/irc/{channel}/notice'

        if command == 'ping':
            if len(tokens) == 2:
                host = tokens[1]
                t = ping(host, unit='ms')

                if t == None:
                    client.publish(response_topic, f'Cannot ping {host} because of an unknown reason')

                else:
                    client.publish(response_topic, f'Pinging {host} took {t:.2f} milliseconds')

            else:
                client.publish(response_topic, 'Invalid number of parameters for ping.')

        elif command == 'time':
            try:
                t        = ntplib.NTPClient()

                response = t.request('myip.vanheusden.com', version=3)

                t_string = time.ctime(response.tx_time)

                tm       = time.localtime(response.tx_time)

                if tm.tm_min == 0:
                    symbols = [ chr(0x1f55b), chr(0x1f550), chr(0x1f551), chr(0x1f552), chr(0x1f553), chr(0x1f554), chr(0x1f555), chr(0x1f556), chr(0x1f557), chr(0x1f558), chr(0x1f559), chr(0x1f55a) ]

                    t_string += ' ' + symbols[tm.tm_hour % 12] + ' '

                elif tm.tm_min == 30:
                    symbols = [ chr(0x1f567), chr(0x1f55c), chr(0x1f55d), chr(0x1f55e), chr(0x1f55f), chr(0x1f560), chr(0x1f561), chr(0x1f562), chr(0x1f563), chr(0x1f564), chr(0x1f565), chr(0x1f566) ]

                    t_string += ' ' + symbols[tm.tm_hour % 12] + ' '

                client.publish(response_topic, f'It is now +/- {t_string} and the computer this bot-plugin runs on is {response.offset:.3f} seconds off.')

            except Exception as e:
                client.publish(response_topic, f'Failed determining time {e}, line number: {e.__traceback__.tb_lineno}')

def on_connect(client, userdata, flags, rc):
    client.subscribe(f'{topic_prefix}from/irc/#')

    client.subscribe(f'{topic_prefix}from/bot/command')

def announce_thread(client):
    while True:
        try:
            announce_commands(client)

            time.sleep(4.1)

        except Exception as e:
            print(f'Failed to announce: {e}')

client = mqtt.Client(f'{socket.gethostname()}_{sys.argv[0]}', clean_session=False)
client.on_message = on_message
client.on_connect = on_connect
client.connect(mqtt_server, port=1883, keepalive=4, bind_address="")

t = threading.Thread(target=announce_thread, args=(client,))
t.start()

client.loop_forever()