12 Commits
0.1 ... 0.2.2

Author SHA1 Message Date
8a6eceb9a5 Added some small fixes and some pepper 2023-08-20 15:53:43 +02:00
2bd8ddeb04 Update README.md 2023-08-13 18:32:35 +02:00
f3ba4f7d67 Update README.md 2023-08-13 18:31:49 +02:00
37d670b54e Added screenshot 2023-08-13 18:30:16 +02:00
12215074d6 Changes in list function 2023-04-19 08:49:22 +02:00
15e8f8ac90 Changes in list function 2023-04-19 08:04:44 +02:00
0e1a5d7314 Fixed error in a function 2023-04-18 14:41:11 +02:00
5d1c11d42d remove .DS_Store 2023-04-17 14:04:53 +02:00
d461290730 remove .DS_Store 2023-04-17 14:04:24 +02:00
38261bb0a2 Better search function 2023-04-17 14:02:58 +02:00
01c158db6d Merge branch 'main' of https://gitlab.pm/rune/malias 2023-04-16 19:07:35 +02:00
7f7c562455 Refined search function 2023-04-16 19:07:01 +02:00
5 changed files with 101 additions and 21 deletions

5
.gitignore vendored
View File

@@ -1 +1,4 @@
list_alias.py list_alias.py
malias.zip
malias_local.py
.DS_Store

View File

@@ -4,7 +4,7 @@ _malias_ is a helper for mailcow instances. You can create, delete, search and l
## Installation ## Installation
Download the latest relase from https://gitlab.pm/rune/malias/releases. Unzip and move to a folder in you path (ease of use). You can also rename the file ```malias.py``` to just ```malias``` and make the file executable with ```chmod +x malias```. To install required python modules run ```pip3 install -r requirements.txt``` Download the latest release from https://gitlab.pm/rune/malias/releases. Unzip and move to a folder in you path (ease of use). I also recommend rename the file ```malias.py``` to just ```malias``` and make the file executable with ```chmod +x malias```. To install required python modules run ```pip3 install -r requirements.txt```
## Usage ## Usage
@@ -14,6 +14,10 @@ For instructions run
malias -h malias -h
``` ```
## Screenshot
![Screenshot of malias](https://gitlab.pm/rune/malias/raw/branch/main/malias.png)
## Contributing ## Contributing
Pull requests are welcome. For major changes, please open an issue first Pull requests are welcome. For major changes, please open an issue first

BIN
malias.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 573 KiB

106
malias.py Normal file → Executable file
View File

@@ -10,12 +10,12 @@ import requests
import os import os
import time import time
import sys import sys
import git
from types import SimpleNamespace from types import SimpleNamespace
from datetime import datetime from datetime import datetime
from string import ascii_letters, digits from string import ascii_letters, digits
from rich import print from rich import print
from argparse import RawTextHelpFormatter from argparse import RawTextHelpFormatter
#from urllib import Request, urlopen
from urllib.request import urlopen from urllib.request import urlopen
# Info pages for dev # Info pages for dev
@@ -29,7 +29,7 @@ database = filepath.joinpath('malias.db')
logfile = filepath.joinpath('malias.log') logfile = filepath.joinpath('malias.log')
Path(filepath).mkdir(parents=True, exist_ok=True) Path(filepath).mkdir(parents=True, exist_ok=True)
logging.basicConfig(filename=logfile,level=logging.INFO,format='%(message)s') logging.basicConfig(filename=logfile,level=logging.INFO,format='%(message)s')
app_version = '0.1' app_version = '0.2.2'
def connect_database(): def connect_database():
@@ -164,8 +164,6 @@ def delete_alias(alias):
response = requests.post('https://'+server+'/api/v1/delete/alias', response = requests.post('https://'+server+'/api/v1/delete/alias',
data=json.dumps(data), headers=headers) data=json.dumps(data), headers=headers)
response_data = response.json() response_data = response.json()
print(response_data)
exit(0)
if response_data[0]['type'] == 'success': if response_data[0]['type'] == 'success':
if check_local_db(the_alias_id) == 1: if check_local_db(the_alias_id) == 1:
now = datetime.now().strftime("%m-%d-%Y %H:%M") now = datetime.now().strftime("%m-%d-%Y %H:%M")
@@ -212,6 +210,7 @@ def copy_data():
def checklist(alias): def checklist(alias):
alias_exist = None
apikey = get_api() apikey = get_api()
mail_server = get_settings('mail_server') mail_server = get_settings('mail_server')
req = urllib.request.Request('https://'+mail_server+'/api/v1/get/alias/all') req = urllib.request.Request('https://'+mail_server+'/api/v1/get/alias/all')
@@ -222,14 +221,21 @@ def checklist(alias):
remoteData = json.loads(remote) remoteData = json.loads(remote)
i = 0 i = 0
for search in remoteData: for search in remoteData:
if alias in remoteData[i]['address']: if alias in remoteData[i]['address'] or alias in remoteData[i]['goto']:
return True alias_exist = True
i=i+1 i=i+1
return None 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
def list_alias(): def list_alias():
apikey = get_api() apikey = get_api()
cursor = conn.cursor()
mail_server = get_settings('mail_server') mail_server = get_settings('mail_server')
req = urllib.request.Request('https://'+mail_server+'/api/v1/get/alias/all') req = urllib.request.Request('https://'+mail_server+'/api/v1/get/alias/all')
req.add_header('Content-Type', 'application/json') req.add_header('Content-Type', 'application/json')
@@ -238,14 +244,23 @@ def list_alias():
remote = current.read().decode('utf-8') remote = current.read().decode('utf-8')
remoteData = json.loads(remote) remoteData = json.loads(remote)
i = 0 i = 0
print('\n[b]malias[/b] - All aliases on %s' %(mail_server)) l = 0
print('===================================================') print('\n[b]malias[/b] - All aliases on %s ([b]*[/b] also in local db)' %(mail_server))
print('==================================================================')
for search in remoteData: for search in remoteData:
the_alias = remoteData[i]['address'].ljust(20,' ') the_alias = remoteData[i]['address'].ljust(20,' ')
print(the_alias + '\tgoes to\t\t' + remoteData[i]['goto']) 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]')
l=l+1
else:
print(the_alias + '\tgoes to\t\t' + the_goto)
i=i+1 i=i+1
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)))
def alias_id(alias): def alias_id(alias):
apikey = get_api() apikey = get_api()
@@ -294,14 +309,65 @@ def check_local_db(alias_id):
def search(alias): def search(alias):
results = checklist(alias) apikey = get_api()
mail_server = get_settings('mail_server') mail_server = get_settings('mail_server')
if results == True: cursor = conn.cursor()
print('\n\nThe mail address %s exists. Using the mailcow instance : %s\n\n'%(alias,mail_server)) 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')
else: else:
print('\n\nThe mail address %s [b]does not[/b] exists. Using the mailcow instance : %s\n\n'%(alias,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
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')
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)
def show_current_info(): def show_current_info():
API = get_api() API = get_api()
@@ -315,12 +381,15 @@ def show_current_info():
aliases_server = number_of_aliases_on_server() aliases_server = number_of_aliases_on_server()
alias_db = number_of_aliases_in_db() alias_db = number_of_aliases_in_db()
mailcow_version = get_mailcow_version()
print('\n[b]malias[/b] - Manage aliases on mailcow Instance.') print('\n[b]malias[/b] - Manage aliases on mailcow Instance.')
print('===================================================') print('===================================================')
print('API key : [b]%s[/b]' % (API)) print('API key : [b]%s[/b]' % (API))
print('mailcow Instance : [b]%s[/b]' % (mail_server)) print('mailcow Instance : [b]%s[/b]' % (mail_server))
print('Mailcow version : [b]%s[/b]' % (mailcow_version))
print('Logfile : [b]%s[/b]' % (logfile)) print('Logfile : [b]%s[/b]' % (logfile))
print('Databse : [b]%s[b]' % (database))
print('Aliases on server : [b]%s[/b]' % (aliases_server)) print('Aliases on server : [b]%s[/b]' % (aliases_server))
print('Aliases in DB : [b]%s[/b]' % (alias_db)) print('Aliases in DB : [b]%s[/b]' % (alias_db))
print('') print('')
@@ -353,7 +422,7 @@ parser.add_argument('-d', '--delete', help='Delete alias.\n\n',
nargs=1, metavar=('alias@domain.com'), required=False, action="append") nargs=1, metavar=('alias@domain.com'), required=False, action="append")
parser.add_argument('-v', '--version', help='Show current version and config info\n\n', parser.add_argument('-i', '--info', help='Show current version and config info\n\n',
required=False, action='store_true') required=False, action='store_true')
parser.add_argument('-c', '--copy', help='Copy alias data from mailcow server to local DB.\n\n', parser.add_argument('-c', '--copy', help='Copy alias data from mailcow server to local DB.\n\n',
@@ -375,7 +444,7 @@ elif args['add']:
create(args['add'][0][0],args['add'][0][1]) create(args['add'][0][0],args['add'][0][1])
elif args['delete']: elif args['delete']:
delete_alias(args['delete'][0][0]) delete_alias(args['delete'][0][0])
elif args['version']: elif args['info']:
show_current_info() show_current_info()
elif args['copy']: elif args['copy']:
copy_data() copy_data()
@@ -384,4 +453,5 @@ elif args['list']:
else: else:
#get_mailcow_version()
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') 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')

View File

@@ -11,7 +11,9 @@ click==8.1.3
docopt==0.6.2 docopt==0.6.2
docutils==0.19 docutils==0.19
frozenlist==1.3.3 frozenlist==1.3.3
gpg==1.19.0 gitdb==4.0.10
GitPython==3.1.32
gpg==1.21.0
idna==3.4 idna==3.4
importlib-metadata==6.1.0 importlib-metadata==6.1.0
jaraco.classes==3.2.3 jaraco.classes==3.2.3
@@ -36,6 +38,7 @@ requests-toolbelt==0.10.1
rfc3986==2.0.0 rfc3986==2.0.0
rich==13.3.1 rich==13.3.1
six==1.16.0 six==1.16.0
smmap==5.0.0
tqdm==4.65.0 tqdm==4.65.0
twine==4.0.2 twine==4.0.2
urllib3==1.26.14 urllib3==1.26.14