Compare commits

...

31 Commits

Author SHA1 Message Date
Homer S. f537edc4cb Script failed when Callers Number was empty i.e. NoneType. Put a['Number'] into str() fixed this. 2021-10-08 09:22:15 +02:00
Homer S. 63a3dee8fd Raised sleep to 10 because 5secs didn't suffice obviously. 2021-07-22 18:20:38 +02:00
Homer S. 558ed192d9 Merge branch 'master' of https://git.ismus.net/homer77/FritzAB2Matrix 2021-07-22 09:32:58 +02:00
Homer S. 2b65daff7f Fixed issue #8 by adding a 5sec delay with time.sleep(5) to multitam(). Request for messages was too fast so that the new message wasn't in it yet. 2021-07-22 09:31:59 +02:00
Homer S. 114e9c3e49 Conditional clauses: Only start script on incoming calls. 2021-07-16 21:41:49 +02:00
Homer S. 3a32e64719 Merge branch 'master' into everycall 2021-07-16 20:54:48 +02:00
Homer S. 97eb34814f Some more fixes on docker build related files. 2021-07-14 21:44:11 +02:00
Homer S. 60adf393ef Further corrections on docker build related files. 2021-07-14 21:08:24 +02:00
Homer S. d91095dcf8 olm-dev was missing in the Dockerfile to build cryptography of matrix-commander. 2021-07-14 20:30:06 +02:00
Homer S. 1949f9f84a Corrected the python-magic item (typo). Also if one doesn't upgrade the requirements matrix-nio won't work. 2021-07-14 19:29:28 +02:00
Homer S. b7fdd6e0e6 Added some condtions to prevent script from breaking if list of missed calls is empty. 2021-07-14 19:27:39 +02:00
Homer S. 6652def351 Merge branch 'docker' 2021-07-11 16:29:12 +02:00
Homer S. 7c299786f0 Reduced image size furtherly. Now 329MB and based on python:alpine. 2021-07-11 16:23:13 +02:00
Homer S. 31cd42b43c Merge branch 'everycall' of https://git.ismus.net/homer77/FritzAB2Matrix into everycall 2021-07-10 23:06:33 +02:00
Homer S. 01f450fca9 Some dependencies were missing to successfully build the docker image. 2021-07-10 23:00:39 +02:00
Homer S. dbc54f595e Updated README regarding missed call feature. 2021-07-10 18:52:01 +02:00
Homer S. 22af5f80eb Get branch to state of master. 2021-07-10 18:42:18 +02:00
Homer S. b2ac69d49f Added option to also notify about missed calls. 2021-07-10 13:40:19 +02:00
Homer S. 7e2ef5822d Uncommented deletion of not longer needed packages from docker image. 2021-07-10 10:22:04 +02:00
Homer S. 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
Homer S. 2462cba3c4 Changed base image to alpine:latest. 2021-07-10 09:08:58 +02:00
Homer S. 78829aadcb added a variable if there were new messages or not 2021-07-10 00:31:20 +02:00
Homer S. 002858c7cc Erroneously had functions twice in code after merge and deleted them. 2021-07-08 22:50:30 +02:00
Homer S. 134e966ed9 Minor markdown correction 2021-07-08 00:03:48 +02:00
Homer S. 4f0cae501c Update about multitam in README 2021-07-07 23:30:25 +02:00
Homer S. 41916ae7c7 Merged with multitam. 2021-07-07 22:50:22 +02:00
Homer S. 0e85b61868 Merge with multitam branch. 2021-07-07 22:31:05 +02:00
Homer S. fe2ce2b420 Nothing to test up to now ... 2021-07-06 23:05:04 +02:00
Homer S. dfe3543777 Test for fritzab2matrix.py 2021-07-06 17:16:00 +02:00
Homer S. 6f696bf970 File to import main file to tests. 2021-07-06 17:15:15 +02:00
Homer S. 25aeeb5c9b Moved helper functions out of the main function. 2021-07-06 17:14:00 +02:00
9 changed files with 160 additions and 75 deletions

7
.env.sample Normal file
View File

@ -0,0 +1,7 @@
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"}'
FRITZ_CALL_WATCH=False

View File

@ -3,7 +3,9 @@
__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)
* Set _FRITZ\_CALL\_WATCH_=True if you want to receive a message everytime you miss a call.
## 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 +25,13 @@ 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"}'
FRITZ_CALL_WATCH=False
``` ```
__.env__ __.env__
@ -53,6 +57,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

@ -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,20 @@ 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 "] olm-dev \
zlib-dev \
jpeg-dev ; \
apk add --no-cache olm libmagic ffmpeg speex; \
pip install pip -U --no-cache-dir; \
pip install --no-cache-dir -r requirements.txt ; \
apk del --no-cache .build-deps;
# ENTRYPOINT ["python3", "-u", "fritzab2matrix.py"]
ENTRYPOINT /bin/sh -c "export UNBUFFERED=1 && 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,13 +1,14 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
from fritzconnection import FritzConnection from fritzconnection import FritzConnection
from fritzconnection.lib.fritzcall import FritzCall, Call
from dotenv import load_dotenv from dotenv import load_dotenv
from pydub import AudioSegment 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, time
import smbclient import smbclient
@ -18,50 +19,97 @@ 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_call_watch = eval(os.environ.get('FRITZ_CALL_WATCH'))
env_tmp = os.environ.get('TEMP_DIR') env_tmp = os.environ.get('TEMP_DIR')
if env_call_watch is None:
env_call_watch = False
elif env_call_watch:
at_least_one_new_message = False
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 get_last_call():
""" Get the last Call. """
try:
fc = FritzCall(address=env_ip,password=env_pass)
except:
print("Couldn't connect to Box")
missed_calls = fc.get_missed_calls(False,1,1)
if len(missed_calls) > 0:
return missed_calls[0]
else:
return False
def lastcall2matrix(tam,tam_no):
# Call Watch to Matrix
if env_call_watch and not at_least_one_new_message:
c = get_last_call()
if c:
c_msg = "{} - {} ({})".format(c.Date, c.Caller, c.Name)
else:
return False
# ... and send message and file to Matrix Room
## if Number of a TAM and the last call match
if tam_no == c.CalledNumber:
cmd = "python3 matrix-commander.py --room {} -m '{}'".format(env_tam[tam],c_msg)
os.system(cmd)
else:
print("Call Watch is off.")
def fritzab2matrix(tam):
### CHECK AND GET MESSAGES FROM FRITZBOX ### ### CHECK AND GET MESSAGES FROM FRITZBOX ###
############################################ ############################################
## Connect to the FritzBox in the LAN ## 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. # 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) fc = FritzConnection(address=env_ip, user=env_user, password=env_pass, use_tls=False)
at_least_one_new_message = False
## 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
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
l = get_message_list(message_list_url) l = get_message_list(message_list_url)
if l['Root'] == None or l['Root']['Message'] == None: if l['Root'] == None or l['Root']['Message'] == None:
@ -76,7 +124,7 @@ def fritzab2matrix():
for a in messages: 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'] + " - " + str(a['Number'])
if a['Name']: if a['Name']:
msg_info += " (" + a['Name'] + ") " msg_info += " (" + a['Name'] + ") "
@ -87,21 +135,21 @@ def fritzab2matrix():
message_new = bool(int(a['New'])) message_new = bool(int(a['New']))
if message_new == True: if message_new == True:
at_least_one_new_message = True
# 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,28 +160,33 @@ 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
print("__ " + msg_info) print("__ " + msg_info)
# ## For testing purposes only tam_no = a['Called']
# if a['Date'].endswith('20:53'): lastcall2matrix(tam,tam_no)
# fc.call_action("X_AVM-DE_TAM1", "MarkMessage", NewIndex=0, NewMessageIndex=int(a['Index']), NewMarkedAsRead=0)
continue
def multitam(tams):
time.sleep(10)
for tam in tams.keys():
print("Check TAM {}.".format(tam))
fritzab2matrix(tam)
continue
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)
@ -15,13 +15,20 @@ def watch_disconnect(monitor, event_queue, func, healthcheck_interval=10):
else: else:
# do event processing here: # do event processing here:
print(event) print(event)
if 'DISCONNECT' in event: if 'DISCONNECT;0' in event:
print("Anruf beendet. Jetzt den AB checken.\n") print("Incoming call stopped. Check the TAM.\n")
func() func(tams)
elif 'DISCONNECT;1' in event:
print("Outgoing call stopped. Do nothing.\n")
else:
print("Unknown event.\n")
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 +36,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 @@
fritzconnection fritzconnection
python-dotenv python-dotenv
xmltodict xmltodict
@ -7,13 +8,16 @@ pydub
# for matrix-commander # for matrix-commander
aiohttp aiohttp
aiofiles<0.5.0,>=0.4.0 aiofiles #<0.5.0,>=0.4.0
argparse argparse
asyncio asyncio
atomicwrites
cachetools
datetime datetime
markdown markdown
matrix-nio[e2e]>=0.14.1 matrix-nio[e2e]>=0.18.3
peewee
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