mirror of
https://codeberg.org/mclemens/colorspot.git
synced 2024-11-16 15:16:04 -05:00
363 lines
16 KiB
Python
Executable File
363 lines
16 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
|
|
# pylint: disable=W1401,C0303
|
|
|
|
|
|
"""
|
|
+---------------------------------------------------------------------+
|
|
| |
|
|
| ___ _ ___ _ |
|
|
| / __|___| |___ _ _/ __|_ __ ___| |_ |
|
|
| | (__/ _ \ / _ \ '_\__ \ '_ \/ _ \ _| |
|
|
| \___\___/_\___/_| |___/ .__/\___/\__| |
|
|
| -= DK1MI =- |_| |
|
|
| |
|
|
| |
|
|
| A colorful cli DX cluster client with an LotW integration |
|
|
| |
|
|
| Author: Michael Clemens, DK1MI (colorspot@qrz.is) |
|
|
| |
|
|
| Documentation: Please see the README.md file |
|
|
| License: Please see the LICENSE file |
|
|
| Repository: https://git.qrz.is/clemens/colorspot |
|
|
| |
|
|
+---------------------------------------------------------------------+
|
|
"""
|
|
|
|
# Infos on colors: https://pypi.org/project/colored/
|
|
|
|
import sys
|
|
import csv
|
|
import re
|
|
import random
|
|
import os
|
|
from os.path import exists
|
|
import configparser
|
|
import zipfile
|
|
from telnetlib import Telnet
|
|
import requests
|
|
from colored import fg, bg, attr
|
|
|
|
class ColorSpot():
|
|
"""ColorSpot class"""
|
|
|
|
def __init__(self):
|
|
"""initialize things"""
|
|
|
|
self.version = "0.1.0"
|
|
|
|
self.print_banner()
|
|
|
|
self.config = configparser.ConfigParser()
|
|
self.config_file = os.path.expanduser('~/.colorspot.ini')
|
|
self.read_config(self.config, self.config_file)
|
|
|
|
self.check_files()
|
|
|
|
if self.check_lotw_confirmed:
|
|
self.confirmed_entities = self.get_confirmed_entities()
|
|
|
|
if self.check_cty:
|
|
#self.cty = list(csv.reader(open(self.config['files']['cty'], "r"), delimiter=","))
|
|
with open(self.config['files']['cty'], encoding='us-ascii') as csvfile:
|
|
self.cty = list(csv.reader(csvfile, delimiter=','))
|
|
|
|
|
|
|
|
def print_banner(self):
|
|
"""print an awesome banner"""
|
|
print(fg(self.rnd_col())+" ___ _ ___ _ ")
|
|
print(fg(self.rnd_col())+" / __|___| |___ _ _/ __|_ __ ___| |_ ")
|
|
print(fg(self.rnd_col())+" | (__/ _ \ / _ \ '_\__ \ '_ \/ _ \ _|")
|
|
print(fg(self.rnd_col())+" \___\___/_\___/_| |___/ .__/\___/\__|")
|
|
print(fg(self.rnd_col())+" -= DK1MI =- |_| ")
|
|
print("")
|
|
print(attr('reset'))
|
|
|
|
|
|
@staticmethod
|
|
def read_config(config, file_name):
|
|
"""reads the configuration from the config file or
|
|
creates a default config file if none could be found"""
|
|
if os.path.isfile(file_name):
|
|
config.read(file_name)
|
|
else:
|
|
config = configparser.ConfigParser()
|
|
config['cluster'] = {
|
|
'host': 'dxc.nc7j.com',
|
|
'port': '7373',
|
|
'user': 'N0CALL',
|
|
'timeout': '100'}
|
|
config['files'] = {
|
|
'cty': 'cty.csv',
|
|
'cty_url': 'https://www.country-files.com/bigcty/download/bigcty.zip',
|
|
'lotw_confirmed': 'lotw.adi',
|
|
'lotw_activity': 'lotw-user-activity.csv',
|
|
'lotw_activity_url': 'https://lotw.arrl.org/lotw-user-activity.csv'}
|
|
config['lotw'] = {
|
|
'user': 'N0CALL',
|
|
'password': 'CHANGEME',
|
|
'mode': 'ssb'}
|
|
config['band_colors'] = {
|
|
"145": "white",
|
|
"144": "white",
|
|
"50": "white",
|
|
"29": "yellow",
|
|
"28": "yellow",
|
|
"24": "red",
|
|
"21": "orchid",
|
|
"18": "green",
|
|
"14": "steel_blue_3",
|
|
"10": "orange_1",
|
|
"7": "cyan",
|
|
"5": "white",
|
|
"3": "light_cyan",
|
|
"1": "white",
|
|
'alert_bg': 'indian_red_1a',
|
|
'alert_fg': 'white',
|
|
'default_bg': 'black'}
|
|
config['cont_colors'] = {
|
|
"AF": "light_salmon_3b",
|
|
"AN": "white",
|
|
"AS": "orange_red_1",
|
|
"EU": "cyan",
|
|
"NA": "steel_blue_3",
|
|
"OC": "orchid",
|
|
"SA": "light_goldenrod_2a"}
|
|
config['colors']= {
|
|
'use_colors': 'yes',
|
|
'color_by' : 'continent',
|
|
'alert_bg': 'indian_red_1a',
|
|
'alert_fg': 'white',
|
|
'default_bg': 'black'}
|
|
|
|
with open(file_name, 'w', encoding='us-ascii') as configfile:
|
|
config.write(configfile)
|
|
print("\nNo configuration file found. A new configuration file has been created.")
|
|
print("\nPlease edit the file " + file_name + " and restart the application.\n" )
|
|
sys.exit()
|
|
return config
|
|
|
|
|
|
@staticmethod
|
|
def rnd_col():
|
|
"""generates a random color cod ein hex"""
|
|
rand = lambda: random.randint(0,255)
|
|
return'#%02X%02X%02X' % (rand(),rand(),rand())
|
|
|
|
|
|
@staticmethod
|
|
def download_file(url, local_filename):
|
|
"""downloads a file via HTTP and saves it to a defined file"""
|
|
with requests.get(url, stream=True) as request:
|
|
request.raise_for_status()
|
|
with open(local_filename, 'wb') as file:
|
|
for chunk in request.iter_content(chunk_size=8192):
|
|
file.write(chunk)
|
|
return local_filename
|
|
|
|
|
|
def check_files(self):
|
|
"""Checks if all necessary files are in the file system.
|
|
Downloads all files and unzips them (if necessary)"""
|
|
# check for lotw qsl information file
|
|
self.check_lotw_confirmed = exists(self.config['files']['lotw_confirmed'])
|
|
if not self.check_lotw_confirmed:
|
|
print("The file " + self.config['files']['lotw_confirmed'] + " is missing.")
|
|
user = self.config['lotw']['user']
|
|
password = self.config['lotw']['password']
|
|
mode = self.config['lotw']['mode']
|
|
url = "https://lotw.arrl.org/lotwuser/lotwreport.adi?login={}&password={}"\
|
|
"&qso_query=1&qso_qsl=yes&qso_mode={}&qso_qsldetail=yes&"\
|
|
"qso_qslsince=1970-01-01".format(user, password, mode)
|
|
print("Trying to download " + url)
|
|
self.download_file(url, self.config['files']['lotw_confirmed'])
|
|
self.check_lotw_confirmed = exists(self.config['files']['lotw_confirmed'])
|
|
if self.check_lotw_confirmed:
|
|
print("File successfully downloaded")
|
|
else:
|
|
print("something went wrong while downloading " + url)
|
|
|
|
# check for cty.csv file
|
|
self.check_cty = exists(self.config['files']['cty'])
|
|
if not self.check_cty:
|
|
url = self.config['files']['cty_url']
|
|
print("The file " + self.config['files']['cty'] + " is missing.")
|
|
print("Trying to download " + url)
|
|
zip_name = self.download_file(url, "bigcty.zip" )
|
|
with zipfile.ZipFile(zip_name, 'r') as zip_ref:
|
|
zip_ref.extract("cty.csv")
|
|
os.remove(zip_name)
|
|
self.check_cty = exists(self.config['files']['cty'])
|
|
if self.check_cty:
|
|
print("File successfully downloaded and extracted.")
|
|
else:
|
|
print("something went wrong while downloading " + url)
|
|
|
|
# check for lotw user activity file
|
|
self.check_lotw_activity = exists(self.config['files']['lotw_activity'])
|
|
if not self.check_lotw_activity:
|
|
url = self.config['files']['lotw_activity_url']
|
|
print("The file " + self.config['files']['lotw_activity'] + " is missing.")
|
|
print("Trying to download " + url)
|
|
self.download_file(url, self.config['files']['lotw_activity'])
|
|
self.check_lotw_activity = exists(self.config['files']['lotw_activity'])
|
|
if self.check_lotw_activity:
|
|
print("File successfully downloaded")
|
|
else:
|
|
print("something went wrong while downloading " + url)
|
|
|
|
|
|
def get_confirmed_entities(self):
|
|
"""Reads the file downlaoded from LotW with all confirmed QSOs,
|
|
extracts all confirmed DXCCs and puts them into a list"""
|
|
ret = []
|
|
with open(self.config['files']['lotw_confirmed'], encoding='us-ascii') as file:
|
|
for row in file:
|
|
if re.search("<DXCC:", row):
|
|
dxcc = row.partition(">")[2].lower().rstrip()
|
|
if dxcc not in ret:
|
|
ret.append(dxcc)
|
|
return ret
|
|
|
|
|
|
def check_lotw(self, call):
|
|
"""Reads the LotW user activity file and returns the date
|
|
of the last upload date if a specific call sign"""
|
|
ret = ""
|
|
#csv_file = csv.reader(open(self.config['files']['lotw_activity'], "r"), delimiter=",")
|
|
with open(self.config['files']['lotw_activity'], encoding='us-ascii') as csvfile:
|
|
csv_file = csv.reader(csvfile, delimiter=',')
|
|
#loop through the csv file
|
|
for row in csv_file:
|
|
if call == row[0]:
|
|
ret = row[1]
|
|
return ret
|
|
return ret
|
|
|
|
|
|
def get_cty_row(self, call):
|
|
"""Parses all CTY records, tries to find the DXCC entity of a
|
|
specific call sign and returns the line as a list of strings"""
|
|
done = False
|
|
while not done:
|
|
for row in self.cty:
|
|
entities = row[9].replace(";", "").replace("=", "").split(" ")
|
|
# TODO: Check if it is a speciall call (=) and mark it in the list
|
|
for prefix in entities:
|
|
if call == prefix:
|
|
return row
|
|
call = call[:-1]
|
|
if call == "":
|
|
return ["-", "-", "-", "-", "-", "-", "-"]
|
|
return None
|
|
|
|
|
|
def get_spots(self):
|
|
"""Connects to the specified telnet dx cluster, performs a login, grabs the
|
|
output row by row, enriches it with data and colorizes it depending on certain
|
|
paramaeters, e.g. by band or continent."""
|
|
with Telnet(self.config['cluster']['host'], int(self.config['cluster']['port']), \
|
|
int(self.config['cluster']['timeout'])) as telnet:
|
|
while True:
|
|
line_enc = telnet.read_until(b"\n") # Read one line
|
|
line = line_enc.decode('ascii')
|
|
# Enters the call sign if requested
|
|
if "enter your call" in line:
|
|
b_user = str.encode(self.config['cluster']['user']+"\n")
|
|
telnet.write(b_user)
|
|
# Detects the beginning of the stream and generates a header line
|
|
elif " Hello " in line:
|
|
print(fg("grey_27") + line + attr("reset"))
|
|
foreground = "white"
|
|
background = "grey_27"
|
|
sep = fg("grey_27")+'|'+fg(foreground)
|
|
row = ["DE", sep, "Freq", sep, "DX", \
|
|
sep, "Country", sep, "C", sep, "L", sep, "Comment", sep, "Time"]
|
|
print(bg(background) + fg(foreground) + \
|
|
'{:9.9} {:<1} {:>7.7} {:<1} {:<10.10} {:<1} '\
|
|
'{:<16.16} {:<1} {:<2.2} {:<1} {:<1.1} {:<1} {:<30.30} '\
|
|
'{:<1} {:<4.4}'.format(*row) + attr("reset"))
|
|
b_cmd = str.encode("sh/dx/50 @\n")
|
|
telnet.write(b_cmd)
|
|
# This is true for every line representing a spot
|
|
elif "DX de" in line or "Dx de" in line:
|
|
try:
|
|
# Extract all necessary fields from the line and store them
|
|
# into different variables.
|
|
call_de = re.search('D(X|x) de (.+?): ', line).group(2)
|
|
freq = re.search(': +(.+?) ', line).group(1)
|
|
call_dx = re.search(freq + ' +(.+?) ', line).group(1)
|
|
time = re.search('[^ ]*$', line).group(0)[0:4]
|
|
comment = re.search(call_dx + ' +(.+?) +' + time, line).group(1)
|
|
|
|
# If the CTY file is available, further information will be
|
|
# gathered from it, e.g. continent, country, dxcc ID
|
|
if self.check_cty:
|
|
cty_details = self.get_cty_row(call_dx)
|
|
else:
|
|
cty_details = ["-","-","-","-","-","-","-","-","-","-"]
|
|
|
|
areaname = cty_details[1]
|
|
continent = cty_details[3]
|
|
|
|
# If the LotW user activity file is available and the call
|
|
# sign in question is actually a LotW user, a checkmark is
|
|
# displayed in a dedicated column of the output
|
|
if self.check_lotw_activity and self.check_lotw(call_dx):
|
|
lotw = "✓"
|
|
else:
|
|
lotw = ""
|
|
|
|
# Depending on the user's choice, the row will be color coded
|
|
# depending on the band or the DX station's continent
|
|
try:
|
|
if self.config['colors']['color_by'] == "band":
|
|
foreground = self.config['band_colors'][freq[:-5]]
|
|
elif self.config['colors']['color_by'] == "continent":
|
|
foreground = self.config['cont_colors'][continent]
|
|
else:
|
|
foreground = "white"
|
|
except Exception:
|
|
foreground = "white"
|
|
|
|
# Removes the trailing .0 from a frequency for better readability
|
|
freq = freq.replace('.0', '')
|
|
|
|
# If the DX station's entity hasn't been worked/confirmed via
|
|
# LotW yet, the row's background will be color coded.
|
|
if self.check_lotw_confirmed and \
|
|
cty_details[2] not in self.confirmed_entities:
|
|
background = self.config['colors']['alert_bg']
|
|
foreground = self.config['colors']['alert_fg']
|
|
else:
|
|
background = self.config['colors']['default_bg']
|
|
|
|
# color of the table separator
|
|
sep = fg("grey_27")+'|'+fg(foreground)
|
|
|
|
# Contructs the row that will be printed
|
|
row = [call_de, sep, freq, sep, call_dx, \
|
|
sep, areaname, sep, continent, sep, lotw, sep, comment, sep, time]
|
|
print(bg(background) + fg(foreground) + \
|
|
'{:9.9} {:<1} {:>7.7} {:<1} {:<10.10} {:<1} '\
|
|
'{:<16.16} {:<1} {:<2.2} {:<1} {:<1.1} {:<1} {:<30.30} '\
|
|
'{:<1} {:<4.4}'.format(*row) + attr("reset"))
|
|
|
|
except AttributeError:
|
|
print(line)
|
|
|
|
def main():
|
|
"""main routine"""
|
|
try:
|
|
color_spot = ColorSpot()
|
|
color_spot.get_spots()
|
|
except KeyboardInterrupt:
|
|
sys.exit(0) # or 1, or whatever
|
|
|
|
if __name__ == "__main__":
|
|
try:
|
|
sys.exit(main())
|
|
except EOFError:
|
|
pass
|