24 Commits

Author SHA1 Message Date
7c299786f0 Reduced image size furtherly. Now 329MB and based on python:alpine. 2021-07-11 16:23:13 +02:00
7e2ef5822d Uncommented deletion of not longer needed packages from docker image. 2021-07-10 10:22:04 +02:00
63004853a3 Merge pull request 'Changed base image to alpine:latest.' (#10) from docker into master
Reviewed-on: #10
2021-07-10 09:12:31 +02:00
2462cba3c4 Changed base image to alpine:latest. 2021-07-10 09:08:58 +02:00
002858c7cc Erroneously had functions twice in code after merge and deleted them. 2021-07-08 22:50:30 +02:00
134e966ed9 Minor markdown correction 2021-07-08 00:03:48 +02:00
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
9e6e294491 Fixed #4 by appending a single message to list. 2021-07-01 20:44:29 +02:00
57243129a3 gitignore emacs autosave files 2021-07-01 19:32:42 +02:00
1aa3662f39 Corrected README.md
I used the wrong option with pip install. Now it's correctly pip install --upgrade pip.
2021-07-01 09:51:43 +02:00
d79b70213b Corrected the FRITZ_VOICEBOX_PATH. 2021-07-01 00:37:23 +02:00
631957e55f Additional remark about the FRITZ_VOICEBOX_PATH variable and use of USB storage with the TAM." 2021-07-01 00:18:02 +02:00
0ef1ea3f43 Corrected hashbang to /usr/bin/env python3 because the docker file couldn't interpret only 'python' ... 2021-07-01 00:04:06 +02:00
adc9eb0a3b Changed main() to fritzab2matrix.py to not to mix up with the __main__ function. Also removed the while loop in the latter which didn't work despite of the recursive function. Also removed the recursive ended_call(main, env_ip) because that broke the script on one tested machine. 2021-06-30 23:36:51 +02:00
8c4bb4e452 Add check if message_list is empty before entering for loop. 2021-06-30 23:21:43 +02:00
8c79991ae7 a['Name'] doesn't get an empty string but type None. So a check for its length led to a failure. 2021-06-30 21:54:50 +02:00
2f827d594c I forgot to pull before I updated file.
Merge branch 'master' of ssh://git.ismus.net:2222/homer77/FritzAB2Matrix
2021-06-30 21:06:19 +02:00
821e44e130 Added env variable FRITZ_VOICEBOX_PATH 2021-06-30 21:06:06 +02:00
10 changed files with 118 additions and 76 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"}'

1
.gitignore vendored
View File

@@ -144,3 +144,4 @@ credentials*
# emacs # emacs
*~ *~
\#*\#

View File

@@ -3,13 +3,15 @@
__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
* Create a new user (e.g. "fritzab") in your _Fritz!Box_. **Don't use your default admin account!** * Create a new user (e.g. "fritzab") in your _Fritz!Box_. **Don't use your default admin account!**
* This user needs only the privileges regarding voice messages and to read from box's storage. * This user needs only the privileges regarding voice messages and to read from box's storage.
* As you only need to access the _FRITZ/voicebox/rec/_ path you should remove the right to read and write everything and add only this path and only with reading privilege. * As you only need to access the _FRITZ/voicebox/rec/_ path you should remove the right to read and write everything and add only this path and only with reading privilege.
* __Beware!__ If you use a USB device as expanded storage for your _Fritz!Box_ and allowed the TAM to use it for storing more messages you will need another path (e.g. _Storage-01/FRITZ/voicebox/rec/_). You also have to add the FRITZ_VOICEBOX_PATH variable in your _.env_ file (see below) according to that difference.
* You have to activate __Call Monitoring__ on your _Fritz!Box_ by using one of the connected phones and call `#96*5*`. * You have to activate __Call Monitoring__ on your _Fritz!Box_ by using one of the connected phones and call `#96*5*`.
* Call monitoring watches the box and the __FritzAB2Matrix__ is triggered every time a call disconnects. * Call monitoring watches the box and the __FritzAB2Matrix__ is triggered every time a call disconnects.
* If you cannot activate Call Monitoring the only way to use __FritzAB2MAtrix__ will be to have a cron job call it regularly. * If you cannot activate Call Monitoring the only way to use __FritzAB2MAtrix__ will be to have a cron job call it regularly.
@@ -19,13 +21,15 @@ If you like to test this repository you are recommended to use one of the follow
* Make it a virtual environment by `python3 -m venv <new folder>` and `source <new folder>/bin/activate`. * Make it a virtual environment by `python3 -m venv <new folder>` and `source <new folder>/bin/activate`.
* `cd <new folder>` * `cd <new folder>`
* Clone the repo. * Clone the repo.
* Inside the repo run `pip install --update 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_TMP="/tmp" FRITZ_TMP="/tmp"
# FRITZ_VOICEBOX_PATH="fritz.nas/FRITZ/voicebox"
FRITZ_TAM='{"0" : "!roomhash1:matrix.org", "1" : "!roomhash2:matrix.org"}'
``` ```
__.env__ __.env__
@@ -52,6 +56,8 @@ Provided you have docker and docker-compose installed on your system:
* 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!
Especially to Especially to

View File

@@ -1,8 +1,9 @@
# syntax=docker/dockerfile:1 # syntax=docker/dockerfile:1
FROM ubuntu:latest FROM python:alpine
ENV TZ=Europe/Berlin ENV TZ=Europe/Berlin
ENV UNBUFFERED=1
WORKDIR /app WORKDIR /app
VOLUME /app VOLUME /app
@@ -10,23 +11,18 @@ VOLUME /app
COPY . . COPY . .
RUN ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone; \ RUN ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone; \
/bin/bash -c 'apt update && apt install -y libolm-dev python3-pip ffmpeg htop; \ apk --no-cache update && apk add --no-cache --virtual .build-deps \
pip install update pip && pip install -r requirements.txt ;' gcc \
cargo \
libffi-dev \
openssl-dev \
ENTRYPOINT ["./fritzab2matrix.py "] zlib-dev \
jpeg-dev ; \
apk add --no-cache ffmpeg speex; \
pip install --no-cache-dir upgrade pip; \
pip install --no-cache-dir -r requirements.txt ; \
apk del --no-cache .build-deps;
ENTRYPOINT ["python3", "-u", "fritzab2matrix.py "]

View File

@@ -7,7 +7,7 @@ services:
context: ../. context: ../.
dockerfile: ./docker/Dockerfile dockerfile: ./docker/Dockerfile
working_dir: /app working_dir: /app
entrypoint: ./fritzab2matrix.py # entrypoint: /bin/sh -c "export UNBUFFERED=1 && python3 -u ./fritzab2matrix.py"
volumes: volumes:
- ../.:/app - ../.:/app

View File

@@ -1,4 +1,4 @@
#!/usr/bin/env python #!/usr/bin/env python3
from fritzconnection import FritzConnection from fritzconnection import FritzConnection
from dotenv import load_dotenv from dotenv import load_dotenv
@@ -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
@@ -17,29 +17,27 @@ load_dotenv()
env_user = os.environ.get('FRITZ_USERNAME') 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_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:
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 main():
### CHECK AND GET MESSAGES FROM FRITZBOX ###
############################################
## Connect to the FritzBox in the LAN
# We don't use tls because the self-signed cert of the box leads to a malfunction in urllib later on.
fc = FritzConnection(address=env_ip, user=env_user, password=env_pass, use_tls=False)
## Get info about messages from the main answering machine
message_list = fc.call_action("X_AVM-DE_TAM1", "GetMessageList", NewIndex=0)
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=0):
url = r"//" + env_ip + r"/fritz.nas/FRITZ/voicebox/rec/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)
return url return url
def download_speex_file(smb_url): def download_speex_file(smb_url):
@@ -57,11 +55,37 @@ def main():
return messages return messages
for a in get_message_list(message_list_url)['Root']['Message']: def fritzab2matrix(tam):
### CHECK AND GET MESSAGES FROM FRITZBOX ###
############################################
## Connect to the FritzBox in the LAN
# We don't use tls because the self-signed cert of the box leads to a malfunction in urllib later on.
fc = FritzConnection(address=env_ip, user=env_user, password=env_pass, use_tls=False)
## Get info about messages from the main answering machine
message_list = fc.call_action("X_AVM-DE_TAM1", "GetMessageList", NewIndex=tam)
message_list_url = message_list['NewURL']
l = get_message_list(message_list_url)
if l['Root'] == None or l['Root']['Message'] == None:
return False
else:
messages = l['Root']['Message']
if type(messages) is not list:
m = []
m.append(messages)
messages = m
for a in messages:
# format the information regarding the message # format the information regarding the message
msg_info = a['Date'] + " - " + a['Number'] msg_info = a['Date'] + " - " + a['Number']
if len(a['Name']) > 1: if a['Name']:
msg_info += " (" + a['Name'] + ") " msg_info += " (" + a['Name'] + ") "
# format the string for sound file's meta information # format the string for sound file's meta information
@@ -75,17 +99,17 @@ def main():
# 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:
@@ -96,7 +120,7 @@ def main():
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
@@ -104,27 +128,25 @@ def main():
# ## 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
### Monitor the FritzBox and trigger the main script whenever a call disconnects ###
###################################################################################
endedCall(main, env_ip)
def multitam(tams):
for tam in tams.keys():
print("Check TAM {}.".format(tam))
fritzab2matrix(tam)
if __name__ == "__main__": if __name__ == "__main__":
try:
print("I enter the main loop ...")
while main():
pass
else:
print("I left the main loop!")
except:
print("An erroneous error happened!") multitam(env_tam)
### Monitor the FritzBox and trigger the main script whenever a call disconnects ###
###################################################################################
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)

View File

@@ -1,3 +1,4 @@
requests
fritzconnection fritzconnection
python-dotenv python-dotenv
xmltodict xmltodict
@@ -7,12 +8,12 @@ pydub
# for matrix-commander # for matrix-commander
aiohttp aiohttp
aiofiles<0.5.0,>=0.4.0 aiofiles
argparse argparse
asyncio asyncio
datetime datetime
markdown markdown
matrix-nio[e2e]>=0.14.1 matrix-nio
Pillow Pillow
python_magic python_magic
uuid uuid

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