7 Commits

Author SHA1 Message Date
4f0cae501c Update about multitam in README 2021-07-07 23:30:25 +02:00
41916ae7c7 Merged with multitam. 2021-07-07 22:50:22 +02:00
0e85b61868 Merge with multitam branch. 2021-07-07 22:31:05 +02:00
fe2ce2b420 Nothing to test up to now ... 2021-07-06 23:05:04 +02:00
dfe3543777 Test for fritzab2matrix.py 2021-07-06 17:16:00 +02:00
6f696bf970 File to import main file to tests. 2021-07-06 17:15:15 +02:00
25aeeb5c9b Moved helper functions out of the main function. 2021-07-06 17:14:00 +02:00
6 changed files with 75 additions and 22 deletions

6
.env.sample Normal file
View File

@@ -0,0 +1,6 @@
FRITZ_USERNAME="fritzab2matrix"
FRITZ_PASSWORD="S0meSecretPa5sw02d"
FRITZ_IP="192.168.178.1"
FRITZ_TMP="/tmp"
FRITZ_VOICEBOX_PATH="fritz.nas/FRITZ/voicebox"
FRITZ_TAM='{"0" : "!roomhash1:matrix.org", "1" : "!roomhash2:matrix.org"}'

View File

@@ -3,7 +3,8 @@
__FritzAB2Matrix__ reads out the answering machine (_TAM_) of a _Fritz!Box_ in your LAN and posts the messages into a private chat in the __matrix__ network. While you could let your _Fritz!Box_ send the messages by mail - unencrypted of course - the matrix chat is __e2e encrypted__. Which kindly acknowledges the privacy of any caller that leaves a message for you. __FritzAB2Matrix__ reads out the answering machine (_TAM_) of a _Fritz!Box_ in your LAN and posts the messages into a private chat in the __matrix__ network. While you could let your _Fritz!Box_ send the messages by mail - unencrypted of course - the matrix chat is __e2e encrypted__. Which kindly acknowledges the privacy of any caller that leaves a message for you.
Uses the python based cmd-line-tool [matrix-commander](https://github.com/8go/matrix-commander) so the matrix-commander.py in this repo is just a copy of that file to ease testing. Uses the python based cmd-line-tool [matrix-commander](https://github.com/8go/matrix-commander) so the matrix-commander.py in this repo is just a copy of that file to ease testing.
## Features
* Since _v0.1.1_ __Multitam__ is integrated so that you can check multiple answering machines __and__ post the messages to different matrix rooms. (Use FRITZ\_TAM_ variable in .env file)
## Installation ## Installation
If you like to test this repository you are recommended to use one of the following two options. If you like to test this repository you are recommended to use one of the following two options.
### Necessary preparations for both cases ### Necessary preparations for both cases
@@ -23,11 +24,12 @@ If you like to test this repository you are recommended to use one of the follow
* Inside the repo run `pip install --upgrade pip && pip install -r requirements.txt` * Inside the repo run `pip install --upgrade pip && pip install -r requirements.txt`
* Create an `.env` file with your favourite editor: * Create an `.env` file with your favourite editor:
``` ```
FRITZ_USERNAME="fritzab" FRITZ_USERNAME="fritzab2matrix"
FRITZ_PASSWORD="SomeRand0mPa55word" FRITZ_PASSWORD="S0meSecretPa5sw02d"
FRITZ_IP="192.168.178.1" FRITZ_IP="192.168.178.1"
FRITZ_VOICEBOX_PATH="fritz.nas/FRITZ/voicebox" FRITZ_TMP="/tmp"
FRITZ_TMP="/tmp" # FRITZ_VOICEBOX_PATH="fritz.nas/FRITZ/voicebox"
FRITZ_TAM='{"0" : "!roomhash1:matrix.org", "1" : "!roomhash2:matrix.org"}'
``` ```
__.env__ __.env__
@@ -53,6 +55,8 @@ Provided you have docker and docker-compose installed on your system:
* With docker that means that you need to open an _interactive shell_ in the running container (`docker-compose -f docker/docker-compose.yml exec app /bin/bash` and run this command there. * With docker that means that you need to open an _interactive shell_ in the running container (`docker-compose -f docker/docker-compose.yml exec app /bin/bash` and run this command there.
* Follow the appearing dialog and input your matrix account data. * Follow the appearing dialog and input your matrix account data.
* After all that the running docker container should watch your box and your TAM messages should be posted in the chosen matrix chat. * After all that the running docker container should watch your box and your TAM messages should be posted in the chosen matrix chat.
### Special Thx ### Special Thx
Gratitude to all people that enabled that project by their passionate work and will to share it! Gratitude to all people that enabled that project by their passionate work and will to share it!

View File

@@ -6,7 +6,7 @@ from pydub import AudioSegment
from libs.monitoring import endedCall from libs.monitoring import endedCall
from libs.message import conversion as conv from libs.message import conversion as conv
import urllib.request import urllib.request
import xmltodict import xmltodict, json
import sys, os import sys, os
import smbclient import smbclient
@@ -18,15 +18,44 @@ env_user = os.environ.get('FRITZ_USERNAME')
env_pass = os.environ.get('FRITZ_PASSWORD') env_pass = os.environ.get('FRITZ_PASSWORD')
env_ip = os.environ.get('FRITZ_IP') env_ip = os.environ.get('FRITZ_IP')
env_voicebox = os.environ.get('FRITZ_VOICEBOX_PATH') env_voicebox = os.environ.get('FRITZ_VOICEBOX_PATH')
env_tam = json.loads(os.environ.get('FRITZ_TAM'))
env_tmp = os.environ.get('TEMP_DIR') env_tmp = os.environ.get('TEMP_DIR')
if env_voicebox is None: if env_voicebox is None:
env_voicebox = "/fritz.nas/FRITZ/voicebox/" env_voicebox = "/fritz.nas/FRITZ/voicebox/"
if env_tam is None:
env_tam = {
"0" : "!MxRrNGhFuQwnIeEWnX:ismus.net"
}
print(env_tam)
if env_tmp is None: if env_tmp is None:
env_tmp = "/tmp" env_tmp = "/tmp"
def fritzab2matrix():
# Build the url to download the message via smb
def build_download_url(mid, tam=0):
recording = "rec." + str(tam) + r"." + str(mid).zfill(3)
url = os.path.join("//",env_ip,env_voicebox,"rec",recording)
return url
def download_speex_file(smb_url):
smbclient.register_session(server=env_ip, username=env_user, password=env_pass, auth_protocol="ntlm")
fd = smbclient.open_file(smb_url, mode="rb")
return fd
def get_message_list(url):
""" Get and and convert the xml formatted list of messages into a dictionary. """
with urllib.request.urlopen(url) as f:
doc = f.read()
# Convert the xml formatted message list to dict
messages = xmltodict.parse(doc)
return messages
def fritzab2matrix(tam):
### CHECK AND GET MESSAGES FROM FRITZBOX ### ### CHECK AND GET MESSAGES FROM FRITZBOX ###
############################################ ############################################
@@ -38,13 +67,13 @@ def fritzab2matrix():
## Get info about messages from the main answering machine ## Get info about messages from the main answering machine
message_list = fc.call_action("X_AVM-DE_TAM1", "GetMessageList", NewIndex=0) message_list = fc.call_action("X_AVM-DE_TAM1", "GetMessageList", NewIndex=tam)
message_list_url = message_list['NewURL'] message_list_url = message_list['NewURL']
# Build the url to download the message via smb # Build the url to download the message via smb
def build_download_url(mid, tam=0): def build_download_url(mid, tam=tam):
recording = "rec." + str(tam) + r"." + str(mid).zfill(3) recording = "rec." + str(tam) + r"." + str(mid).zfill(3)
url = os.path.join("//",env_ip,env_voicebox,"rec",recording) url = os.path.join("//",env_ip,env_voicebox,"rec",recording)
return url return url
@@ -91,17 +120,17 @@ def fritzab2matrix():
# Download and convert the speex files to wav # Download and convert the speex files to wav
smb_url = build_download_url(a['Index']) smb_url = build_download_url(a['Index'])
speex_fd = download_speex_file(smb_url) speex_fd = download_speex_file(smb_url)
conv.speex_convert(speex_fd, os.path.join(env_tmp,"message.wav")) conv.speex_convert(speex_fd, os.path.join(env_tmp,"message{}.wav".format(tam)))
# Convert wav to ogg # Convert wav to ogg
msg = AudioSegment.from_wav(os.path.join(env_tmp,"message.wav")) msg = AudioSegment.from_wav(os.path.join(env_tmp,"message{}.wav".format(tam)))
# Only if message is longer than 5 seconds ... # Only if message is longer than 5 seconds ...
if msg.duration_seconds > 5.0: if msg.duration_seconds > 5.0:
# ... export to ogg ... # ... export to ogg ...
msg.export(os.path.join(env_tmp,"message.ogg"), format="ogg", tags=msg_tags) msg.export(os.path.join(env_tmp,"message{}.ogg".format(tam)), format="ogg", tags=msg_tags)
# ... and send message and file to Matrix Room # ... and send message and file to Matrix Room
command = "python3 matrix-commander.py -a " + os.path.join(env_tmp,"message.ogg") + " -m '{}'".format(msg_info) command = "python3 matrix-commander.py --room {} -a ".format(env_tam[tam]) + os.path.join(env_tmp,"message{}.ogg".format(tam)) + " -m '{}'".format(msg_info)
os.system(command) os.system(command)
else: else:
@@ -112,7 +141,7 @@ def fritzab2matrix():
print("** " + msg_info) print("** " + msg_info)
# Mark processed messages as 'read' # Mark processed messages as 'read'
fc.call_action("X_AVM-DE_TAM1", "MarkMessage", NewIndex=0, NewMessageIndex=int(a['Index']), NewMarkedAsRead=1) fc.call_action("X_AVM-DE_TAM1", "MarkMessage", NewIndex=tam, NewMessageIndex=int(a['Index']), NewMarkedAsRead=1)
else: else:
# Show that message is already read # Show that message is already read
@@ -120,20 +149,24 @@ def fritzab2matrix():
# ## For testing purposes only # ## For testing purposes only
# if a['Date'].endswith('20:53'): # if a['Date'].endswith('20:53'):
# fc.call_action("X_AVM-DE_TAM1", "MarkMessage", NewIndex=0, NewMessageIndex=int(a['Index']), NewMarkedAsRead=0) # fc.call_action("X_AVM-DE_TAM1", "MarkMessage", NewIndex=1, NewMessageIndex=int(a['Index']), NewMarkedAsRead=0)
continue continue
continue continue
def multitam(tams):
for tam in tams.keys():
print("Check TAM {}.".format(tam))
fritzab2matrix(tam)
if __name__ == "__main__": if __name__ == "__main__":
fritzab2matrix()
multitam(env_tam)
### Monitor the FritzBox and trigger the main script whenever a call disconnects ### ### Monitor the FritzBox and trigger the main script whenever a call disconnects ###
################################################################################### ###################################################################################
endedCall(fritzab2matrix, env_ip) endedCall(multitam,env_tam, env_ip)

View File

@@ -4,7 +4,7 @@ from fritzconnection.core.fritzmonitor import FritzMonitor
### Monitor the calls of a fritzbox continously ### ### Monitor the calls of a fritzbox continously ###
################################################### ###################################################
def watch_disconnect(monitor, event_queue, func, healthcheck_interval=10): def watch_disconnect(monitor, event_queue, func, tams, healthcheck_interval=10):
while True: while True:
try: try:
event = event_queue.get(timeout=healthcheck_interval) event = event_queue.get(timeout=healthcheck_interval)
@@ -17,11 +17,11 @@ def watch_disconnect(monitor, event_queue, func, healthcheck_interval=10):
print(event) print(event)
if 'DISCONNECT' in event: if 'DISCONNECT' in event:
print("Anruf beendet. Jetzt den AB checken.\n") print("Anruf beendet. Jetzt den AB checken.\n")
func() func(tams)
def endedCall(func, fritz_ip='192.168.1.1'): def endedCall(func, tams, fritz_ip='192.168.1.1'):
""" """
Call this to trigger a given function if a call is disconnected Call this to trigger a given function if a call is disconnected
""" """
@@ -29,7 +29,7 @@ def endedCall(func, fritz_ip='192.168.1.1'):
# as a context manager FritzMonitor will shut down the monitor thread # as a context manager FritzMonitor will shut down the monitor thread
with FritzMonitor(address=fritz_ip) as monitor: with FritzMonitor(address=fritz_ip) as monitor:
event_queue = monitor.start() event_queue = monitor.start()
watch_disconnect(monitor, event_queue, func) watch_disconnect(monitor, event_queue, func, tams)
except (OSError, KeyboardInterrupt) as err: except (OSError, KeyboardInterrupt) as err:
print(err) print(err)

5
tests/context.py Normal file
View File

@@ -0,0 +1,5 @@
import os
import sys
sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
import fritzab2matrix

View File

@@ -0,0 +1,5 @@
from context import fritzab2matrix as fab2m