malias/malias.py

457 lines
15 KiB
Python
Raw Normal View History

2023-04-10 15:07:53 +02:00
#!/usr/bin/python3
import sqlite3
from pathlib import Path
from sqlite3 import Error
import urllib.request
import json
import logging
import argparse
import requests
import os
import time
import sys
2023-08-20 15:53:43 +02:00
import git
2023-04-10 15:07:53 +02:00
from types import SimpleNamespace
from datetime import datetime
from string import ascii_letters, digits
from rich import print
from argparse import RawTextHelpFormatter
2023-04-12 11:57:35 +02:00
from urllib.request import urlopen
2023-04-10 15:07:53 +02:00
# Info pages for dev
# https://mailcow.docs.apiary.io/#reference/aliases/get-aliases/get-aliases
# https://demo.mailcow.email/api/#/Aliases
homefilepath = Path.home()
filepath = homefilepath.joinpath('.config/malias')
database = filepath.joinpath('malias.db')
logfile = filepath.joinpath('malias.log')
Path(filepath).mkdir(parents=True, exist_ok=True)
logging.basicConfig(filename=logfile,level=logging.INFO,format='%(message)s')
2023-08-20 15:53:43 +02:00
app_version = '0.2.2'
2023-04-10 15:07:53 +02:00
def connect_database():
Path(filepath).mkdir(parents=True, exist_ok=True)
conn = None
try:
conn = sqlite3.connect(database)
except Error as e:
logging.error(time.strftime("%Y-%m-%d %H:%M") + ' - Error : ' + str(e))
print(e)
finally:
if conn:
c = conn.cursor()
c.execute('''CREATE TABLE IF NOT EXISTS apikey
(id integer NOT NULL PRIMARY KEY,
api text NOT NULL)''')
2023-04-11 13:01:37 +02:00
c.execute('''CREATE TABLE IF NOT EXISTS settings (
id INTEGER NOT NULL PRIMARY KEY,
2023-04-13 09:29:07 +02:00
first_run INTEGER,
server TEXT,
2023-04-16 18:04:24 +02:00
data_copy INTEGER
2023-04-11 13:01:37 +02:00
)''')
2023-04-10 15:07:53 +02:00
c.execute('''CREATE TABLE IF NOT EXISTS aliases
2023-04-11 13:01:37 +02:00
(id integer NOT NULL PRIMARY KEY,
alias text NOT NULL,
goto text NOT NULL,
created text NOT NULL)''')
2023-04-10 15:07:53 +02:00
2023-04-11 13:01:37 +02:00
conn.commit()
first_run(conn)
2023-04-10 15:07:53 +02:00
return conn
2023-04-11 13:01:37 +02:00
2023-04-16 18:04:24 +02:00
2023-04-11 13:01:37 +02:00
def first_run(conn):
now = datetime.now().strftime("%m-%d-%Y %H:%M")
2023-04-10 15:07:53 +02:00
cursor = conn.cursor()
2023-04-11 13:01:37 +02:00
cursor.execute('SELECT count(*) FROM settings')
2023-04-10 15:07:53 +02:00
count = cursor.fetchone()[0]
if count == 0:
2023-04-11 13:01:37 +02:00
logging.error(now + ' - First run!')
2023-04-16 18:04:24 +02:00
cursor.execute('INSERT INTO settings values(?,?,?,?)', (1, 1, 'dummy.server',0))
2023-04-11 13:01:37 +02:00
cursor.execute('INSERT INTO apikey values(?,?)', (1, 'DUMMY_KEY'))
conn.commit()
2023-04-10 15:07:53 +02:00
return None
2023-04-11 13:01:37 +02:00
def get_settings(kind):
cursor = conn.cursor()
cursor.execute('SELECT * FROM settings')
data = cursor.fetchall()
first_run_status = data[0][1]
mail_server = data[0][2]
2023-04-16 18:04:24 +02:00
copy_status = data[0][3]
2023-04-11 13:01:37 +02:00
if kind == 'mail_server':
if mail_server == 'dummy.server':
2023-04-16 18:04:24 +02:00
print('Error: No mailcow server active. Please add one with [b]malias -m [i]your.server[/i][/b]')
2023-04-11 13:01:37 +02:00
exit(0)
else:
return mail_server
if kind == 'first_run_status':
return first_run_status
2023-04-16 18:04:24 +02:00
if kind == 'copy_status':
return copy_status
2023-04-11 13:01:37 +02:00
def get_api():
cursor = conn.cursor()
cursor.execute('SELECT api FROM apikey')
apikey = cursor.fetchone()[0]
if apikey == 'DUMMY_KEY':
print('Missing API key. Please add with [b]malias -k [i]YOUR-API-KEY[/i][/b]')
exit(0)
2023-04-10 15:07:53 +02:00
else:
2023-04-11 13:01:37 +02:00
return apikey
2023-04-10 15:07:53 +02:00
2023-04-11 13:01:37 +02:00
def set_mailserver(server):
now = datetime.now().strftime("%m-%d-%Y %H:%M")
cursor = conn.cursor()
cursor.execute('UPDATE settings SET server = ? WHERE id = 1',(server,))
2023-04-16 18:04:24 +02:00
logging.info(now + ' - Info : mailcow server updated')
2023-04-11 13:01:37 +02:00
print('Your mail server has been updated.')
conn.commit()
2023-04-10 15:07:53 +02:00
def apikey(key):
2023-04-11 13:01:37 +02:00
now = datetime.now().strftime("%m-%d-%Y %H:%M")
2023-04-10 15:07:53 +02:00
cursor = conn.cursor()
2023-04-11 13:01:37 +02:00
cursor.execute('UPDATE apikey SET api = ? WHERE id = 1',(key,))
logging.info(now + ' - Info : API key updated')
print('Your API key has been updated.')
conn.commit()
def create(alias,to_address):
now = datetime.now().strftime("%m-%d-%Y %H:%M")
server = get_settings('mail_server')
apikey = get_api()
if checklist(alias) == True:
2023-04-16 18:04:24 +02:00
logging.error(now + ' - Error : alias %s exists on the mailcow instance %s ' %(alias,server))
print('\n[b]Error[/b] : alias %s exists on the mailcow instance %s \n' %(alias,server))
2023-04-11 13:01:37 +02:00
exit(0)
2023-04-10 15:07:53 +02:00
else:
2023-04-12 11:57:35 +02:00
data = {'address': alias,'goto': to_address,'active': "1"}
headers = {'X-API-Key': apikey, "Content-Type": "application/json"}
response = requests.post('https://'+server+'/api/v1/add/alias',
data=json.dumps(data), headers=headers)
mail_id = alias_id(alias)
if mail_id == None:
2023-04-16 18:04:24 +02:00
logging.error(now + ' - Error : alias %s not created on the mailcow instance %s ' %(alias,server))
print('\n[b]Error[/b] : alias %s exists on the mailcow instance %s \n' %(alias,server))
2023-04-12 11:57:35 +02:00
else:
cursor = conn.cursor()
cursor.execute('INSERT INTO aliases values(?,?,?,?)', (mail_id, alias,to_address,now))
conn.commit()
2023-04-16 18:04:24 +02:00
logging.info(now + ' - Info : alias %s created for %s on the mailcow instance %s ' %(alias,to_address,server))
print('\n[b]Info[/b] : alias %s created for %s on the mailcow instance %s \n' %(alias,to_address,server))
2023-04-12 11:57:35 +02:00
2023-04-10 15:07:53 +02:00
2023-04-12 11:57:35 +02:00
2023-04-16 18:04:24 +02:00
def delete_alias(alias):
server = get_settings('mail_server')
apikey = get_api()
if checklist(alias) == True:
the_alias_id = alias_id(alias)
data = {'id': the_alias_id}
headers = {'X-API-Key': apikey, "Content-Type": "application/json"}
response = requests.post('https://'+server+'/api/v1/delete/alias',
data=json.dumps(data), headers=headers)
response_data = response.json()
if response_data[0]['type'] == 'success':
if check_local_db(the_alias_id) == 1:
now = datetime.now().strftime("%m-%d-%Y %H:%M")
cursor = conn.cursor()
cursor.execute('DELETE from aliases where id = ?',(the_alias_id,))
logging.info(now + ' - Info : alias %s deleted from the mailcow instance %s and Local DB' %(alias,server))
conn.commit()
print('\n[b]Info[/b] : alias %s deleted from the mailcow instance %s and local DB' %(alias,server))
else:
logging.info(now + ' - Info : alias %s deleted from the mailcow instance %s.' %(alias,server))
print('\n[b]Info[/b] : alias %s deleted from the mailcow instance %s.' %(alias,server))
else:
logging.error(now + ' - Error : alias %s NOT deleted from the mailcow instance %s. Error : %s' %(alias,server,response_data))
conn.commit()
print('\n[b]Error[/b] : alias %s NOT deleted from the mailcow instance %s. Error : %s' %(alias,server,response_data))
else:
print('\n[b]Error[/b] : The alias %s not found')
2023-04-10 15:07:53 +02:00
2023-04-13 09:29:07 +02:00
def copy_data():
2023-04-16 18:04:24 +02:00
apikey = get_api()
mail_server = get_settings('mail_server')
if get_settings('copy_status') == 0:
now = datetime.now().strftime("%m-%d-%Y %H:%M")
cursor = conn.cursor()
req = urllib.request.Request('https://'+mail_server+'/api/v1/get/alias/all')
req.add_header('Content-Type', 'application/json')
req.add_header('X-API-Key', apikey)
current = urllib.request.urlopen(req)
remote = current.read().decode('utf-8')
remoteData = json.loads(remote)
i = 0
for data in remoteData:
cursor.execute('INSERT INTO aliases values(?,?,?,?)', (remoteData[i]['id'], remoteData[i]['address'],remoteData[i]['goto'],now))
i=i+1
cursor.execute('UPDATE settings SET data_copy = ? WHERE id = 1',(1,))
conn.commit()
logging.info(now + ' - Info : aliases imported from the mailcow instance %s to local DB' %(mail_server))
print('\n[b]Info[/b] : aliases imported from the mailcow instance %s to local DB\n' %(mail_server))
else:
print('\n[b]Info[/b] : aliases alreday imported from the mailcow instance %s to local DB\n' %(mail_server))
2023-04-13 09:29:07 +02:00
2023-04-10 15:07:53 +02:00
def checklist(alias):
2023-04-18 14:41:11 +02:00
alias_exist = None
2023-04-10 15:07:53 +02:00
apikey = get_api()
2023-04-11 13:01:37 +02:00
mail_server = get_settings('mail_server')
req = urllib.request.Request('https://'+mail_server+'/api/v1/get/alias/all')
2023-04-10 15:07:53 +02:00
req.add_header('Content-Type', 'application/json')
req.add_header('X-API-Key', apikey)
current = urllib.request.urlopen(req)
remote = current.read().decode('utf-8')
remoteData = json.loads(remote)
i = 0
for search in remoteData:
2023-04-18 14:41:11 +02:00
if alias in remoteData[i]['address'] or alias in remoteData[i]['goto']:
alias_exist = True
2023-04-10 15:07:53 +02:00
i=i+1
2023-04-18 14:41:11 +02:00
cursor = conn.cursor()
cursor.execute('SELECT count(*) FROM aliases where alias like ? or goto like ?', (alias,alias,))
count = cursor.fetchone()[0]
if count >= 1 :
alias_exist = True
return alias_exist
2023-04-10 15:07:53 +02:00
2023-04-12 11:57:35 +02:00
def list_alias():
2023-04-11 13:01:37 +02:00
apikey = get_api()
2023-04-19 08:04:44 +02:00
cursor = conn.cursor()
2023-04-11 13:01:37 +02:00
mail_server = get_settings('mail_server')
req = urllib.request.Request('https://'+mail_server+'/api/v1/get/alias/all')
req.add_header('Content-Type', 'application/json')
req.add_header('X-API-Key', apikey)
current = urllib.request.urlopen(req)
remote = current.read().decode('utf-8')
remoteData = json.loads(remote)
i = 0
2023-04-19 08:49:22 +02:00
l = 0
2023-04-19 08:04:44 +02:00
print('\n[b]malias[/b] - All aliases on %s ([b]*[/b] also in local db)' %(mail_server))
print('==================================================================')
2023-04-12 11:57:35 +02:00
for search in remoteData:
2023-04-16 18:04:24 +02:00
the_alias = remoteData[i]['address'].ljust(20,' ')
2023-04-19 08:04:44 +02:00
the_goto = remoteData[i]['goto'].ljust(20,' ')
cursor.execute('SELECT count(*) FROM aliases where alias like ? or goto like ?', (remoteData[i]['address'],remoteData[i]['address'],))
count = cursor.fetchone()[0]
if count >= 1:
print(the_alias + '\tgoes to\t\t' + the_goto + '\t[b]*[/b]')
2023-04-19 08:49:22 +02:00
l=l+1
2023-04-19 08:04:44 +02:00
else:
print(the_alias + '\tgoes to\t\t' + the_goto)
2023-04-11 13:01:37 +02:00
i=i+1
2023-04-19 08:49:22 +02:00
print('\n\nTotal number of aliases %s on instance [b]%s[/b] and %s on [b]local DB[/b].' %(str(i),mail_server,str(l)))
2023-04-19 08:04:44 +02:00
2023-04-12 11:57:35 +02:00
def alias_id(alias):
apikey = get_api()
mail_server = get_settings('mail_server')
req = urllib.request.Request('https://'+mail_server+'/api/v1/get/alias/all')
req.add_header('Content-Type', 'application/json')
req.add_header('X-API-Key', apikey)
current = urllib.request.urlopen(req)
remote = current.read().decode('utf-8')
remoteData = json.loads(remote)
i = 0
for search in remoteData:
if remoteData[i]['address'] == alias:
return remoteData[i]['id']
i=i+1
return None
2023-04-11 13:01:37 +02:00
def number_of_aliases_in_db():
cursor = conn.cursor()
cursor.execute('SELECT count(*) FROM aliases')
count = cursor.fetchone()[0]
return count
2023-04-16 18:04:24 +02:00
def number_of_aliases_on_server():
apikey = get_api()
mail_server = get_settings('mail_server')
req = urllib.request.Request('https://'+mail_server+'/api/v1/get/alias/all')
req.add_header('Content-Type', 'application/json')
req.add_header('X-API-Key', apikey)
current = urllib.request.urlopen(req)
remote = current.read().decode('utf-8')
remoteData = json.loads(remote)
return len(remoteData)
def check_local_db(alias_id):
cursor = conn.cursor()
cursor.execute('SELECT count(*) FROM aliases where id = ?',(alias_id,))
count = cursor.fetchone()[0]
return count
2023-04-10 15:07:53 +02:00
def search(alias):
2023-04-17 14:02:58 +02:00
apikey = get_api()
2023-04-11 13:01:37 +02:00
mail_server = get_settings('mail_server')
2023-04-17 14:02:58 +02:00
cursor = conn.cursor()
cursor.execute('SELECT data_copy FROM settings where id = 1')
result = cursor.fetchone()[0]
if result == 1:
search_term = '%'+alias+'%'
cursor.execute('SELECT * from aliases where alias like ? or goto like ?',(search_term,search_term,))
remoteData = cursor.fetchall()
i = 0
print('\nAliases on %s that contains %s' %(mail_server,alias))
print('=================================================================')
for search in remoteData:
the_alias = remoteData[i][1].ljust(20,' ')
print(the_alias + '\tgoes to\t\t' + remoteData[i][2])
i=i+1
print('\n\nData from local DB')
2023-04-11 13:01:37 +02:00
else:
2023-04-17 14:02:58 +02:00
req = urllib.request.Request('https://'+mail_server+'/api/v1/get/alias/all')
req.add_header('Content-Type', 'application/json')
req.add_header('X-API-Key', apikey)
current = urllib.request.urlopen(req)
remote = current.read().decode('utf-8')
remoteData = json.loads(remote)
i = 0
print('\nAliases on %s that contains %s' %(mail_server,alias))
print('=================================================')
for search in remoteData:
if alias in remoteData[i]['address'] or alias in remoteData[i]['goto']:
print(remoteData[i]['address'] + '\tgoes to\t\t' + remoteData[i]['goto'])
i=i+1
print('\n\nData from server')
2023-04-11 13:01:37 +02:00
2023-04-10 15:07:53 +02:00
2023-08-20 15:53:43 +02:00
def get_mailcow_version():
apikey = get_api()
mail_server = get_settings('mail_server')
req = urllib.request.Request('https://'+mail_server+'/api/v1/get/status/version')
req.add_header('Content-Type', 'application/json')
req.add_header('X-API-Key', apikey)
current = urllib.request.urlopen(req)
remote = current.read().decode('utf-8')
remoteData = json.loads(remote)
#repo = Repo("https://github.com/mailcow/mailcow-dockerized")
# info = repo.git.ls_remote()
# tags = repo.tags
remote_heads = git.cmd.Git().ls_remote('https://github.com/mailcow/mailcow-dockerized', tags=True)
# tags = remote_heads.rstrip('refs/tags/')
tags = remote_heads.splitlines()
for x in tags:
string = x.rsplit('/',2)
if remoteData['version'] != string[2]:
versionInfo = 'Your Mailcow version is %s and the latest is %s' %(remoteData['version'], string[2])
else:
versionInfo = 'You have the latest Mailcow version %s' %remoteData['version']
return (versionInfo)
2023-04-11 13:01:37 +02:00
def show_current_info():
API = get_api()
mail_server = get_settings('mail_server')
if API == 'DUMMY_KEY':
API = 'Missing API Key!'
if mail_server == 'dummy.server':
2023-04-16 18:04:24 +02:00
mail_server = 'Missing address to mailcow instance!'
2023-04-11 13:01:37 +02:00
aliases_server = number_of_aliases_on_server()
alias_db = number_of_aliases_in_db()
2023-08-20 15:53:43 +02:00
mailcow_version = get_mailcow_version()
2023-04-11 13:01:37 +02:00
2023-04-16 18:04:24 +02:00
print('\n[b]malias[/b] - Manage aliases on mailcow Instance.')
2023-04-11 13:01:37 +02:00
print('===================================================')
print('API key : [b]%s[/b]' % (API))
2023-04-16 18:04:24 +02:00
print('mailcow Instance : [b]%s[/b]' % (mail_server))
2023-08-20 15:53:43 +02:00
print('Mailcow version : [b]%s[/b]' % (mailcow_version))
2023-04-11 13:01:37 +02:00
print('Logfile : [b]%s[/b]' % (logfile))
2023-08-20 15:53:43 +02:00
print('Databse : [b]%s[b]' % (database))
2023-04-11 13:01:37 +02:00
print('Aliases on server : [b]%s[/b]' % (aliases_server))
print('Aliases in DB : [b]%s[/b]' % (alias_db))
print('')
print('App version : [b]%s[/b] (https://gitlab.pm/rune/malias)' % (app_version))
print('')
2023-04-10 15:07:53 +02:00
conn = connect_database()
2023-04-11 13:01:37 +02:00
2023-04-10 15:07:53 +02:00
parser = argparse.ArgumentParser(prog='malias',
2023-04-16 18:04:24 +02:00
description='This is a simple application to help you create and delete aliases on a mailcow instance.\nIf you find any issues or would like to submit a PR - please head over to https://gitlab.pm/rune/malias. \n\nI hope this makes your mailcow life a bit easier!',
2023-04-10 15:07:53 +02:00
formatter_class=RawTextHelpFormatter,
2023-04-16 18:04:24 +02:00
epilog='Making mailcow easier...')
2023-04-10 15:07:53 +02:00
parser.add_argument('-k', '--api', help='Add/Change API key.\n\n',
nargs=1, metavar=('APIkey'), required=False, action="append")
parser.add_argument('-s', '--search', help='Search for alias.\n\n',
nargs=1, metavar=('alias@domain.com'), required=False, action="append")
2023-04-16 18:04:24 +02:00
parser.add_argument('-m', '--server', help='Add/Uppdate mailcow instance.\n\n',
nargs=1, metavar=('mailcow-server.tld'), required=False, action="append")
2023-04-11 13:01:37 +02:00
parser.add_argument('-a', '--add', help='Add new alias.\n\n',
nargs=2, metavar=('alias@domain.com', 'to@domain.com'), required=False, action="append")
2023-04-16 18:04:24 +02:00
parser.add_argument('-d', '--delete', help='Delete alias.\n\n',
nargs=1, metavar=('alias@domain.com'), required=False, action="append")
2023-08-20 15:53:43 +02:00
parser.add_argument('-i', '--info', help='Show current version and config info\n\n',
2023-04-11 13:01:37 +02:00
required=False, action='store_true')
2023-04-10 15:07:53 +02:00
2023-04-16 18:04:24 +02:00
parser.add_argument('-c', '--copy', help='Copy alias data from mailcow server to local DB.\n\n',
required=False, action='store_true')
parser.add_argument('-l', '--list', help='List all aliases on the Mailcow instance.\n\n',
2023-04-13 09:29:07 +02:00
required=False, action='store_true')
2023-04-16 18:04:24 +02:00
2023-04-10 15:07:53 +02:00
args = vars(parser.parse_args())
if args['api']:
apikey(args['api'][0][0])
elif args['search']:
search(args['search'][0][0])
2023-04-11 13:01:37 +02:00
elif args['server']:
set_mailserver(args['server'][0][0])
elif args['add']:
create(args['add'][0][0],args['add'][0][1])
2023-04-16 18:04:24 +02:00
elif args['delete']:
delete_alias(args['delete'][0][0])
2023-08-20 15:53:43 +02:00
elif args['info']:
2023-04-11 13:01:37 +02:00
show_current_info()
2023-04-16 18:04:24 +02:00
elif args['copy']:
2023-04-13 09:29:07 +02:00
copy_data()
2023-04-16 18:04:24 +02:00
elif args['list']:
list_alias()
2023-04-10 15:07:53 +02:00
else:
2023-08-20 15:53:43 +02:00
#get_mailcow_version()
2023-04-16 18:04:24 +02:00
print('\n\nEh, sorry! I need something more to help you! If you write [b]malias -h[/b] I\'ll show a help screen to get you going!!!\n\n\n')