Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated the code to check if the website returns an IPv6 result #3

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Updated the code to check if the website returns an IPv6 result #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e30328d
Updated the code to check if the website returns an IPv6 result
Xenomes Oct 21, 2023
5c2b383
Small update and default 1 hour check
Xenomes Oct 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
148 changes: 68 additions & 80 deletions plugin.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,20 @@
# : Bug Fixes
# 1.2.3 : "localhost" to "127.0.0.1"
# 1.2.4 : Limit notifications to email
# 1.2.5 :
# 1.2.5 :
# 1.2.6 : Fix (by gilmrt) for "Error: IP WAN hardware (XX) thread seems to have ended unexpectedly"
#
#
# 1.2.7 : Update by Xenomes "Updated the code to check if the website returns an IPv6 result"
#
"""
<plugin key="WAN-IP-CHECKER" name="Wan IP Checker" author="ycahome" version="1.2.6" externallink="https://www.domoticz.com/forum/viewtopic.php?t=16266">
<plugin key="WAN-IP-CHECKER" name="Wan IP Checker" author="ycahome" version="1.2.7" externallink="https://www.domoticz.com/forum/viewtopic.php?t=16266">
<description>
<h2>Wan IP Checker v.1.2.6</h2><br/>
<h2>Wan IP Checker v.1.2.7</h2><br/>
</description>
<params>
<param field="Address" label="Check My IP URL" width="200px" required="true" default="https://ifconfig.me/ip"/>
<param field="Mode1" label="Check Interval(seconds)" width="75px" required="true" default="60"/>
<param field="Mode2" label="IP Address" width="200px" required="true" default="127.0.0.1"/>
<param field="Port" label="Port" width="30px" required="true" default="8080"/>
<param field="Address" label="Check My IP URL" width="200px" required="true" default="https://api.ipify.org"/>
<param field="Mode1" label="Check Interval(seconds)" width="75px" required="true" default="3600"/>
<param field="Mode3" label="Notifications" width="75px">
<options>
<option label="Notify" value="Notify"/>
Expand All @@ -39,16 +40,12 @@
"""

import Domoticz
import hmac
import hashlib
import time
import urllib
import urllib.request
import urllib.error
import sys

#from urllib2 import urlopen
from datetime import datetime, timedelta

from datetime import datetime

class BasePlugin:
enabled = False
Expand Down Expand Up @@ -90,7 +87,7 @@ def onStart(self):
# create the mandatory child device if it does not yet exist
if 1 not in Devices:
Domoticz.Device(Name="WAN IP Alert", Unit=1, TypeName="Alert", Used=1).Create()
#Domoticz.Device(Name="WAN IP 1", Unit=1, TypeName="Text", Used=1).Create()
#Domoticz.Device(Name="WAN IP 1", Unit=1, TypeName="Text", Used=1).Create()
Domoticz.Log("Device created.")

Domoticz.Heartbeat(self.heartbeatsInterval)
Expand All @@ -115,67 +112,65 @@ def checkIP(self):
url = Parameters["Address"]

if mid(url,0,7)!= "http://" and mid(url,0,8)!= "https://" :
Domoticz.Error("Check my IP URL Prefix is wrong: 'http://' or 'https://' required.")
return
Domoticz.Error("Check my IP URL Prefix is wrong: 'http://' or 'https://' required.")
return

try:
response = urllib.request.urlopen(url, timeout = 30).read()
response = urllib.request.urlopen(url, timeout = 30).read()
except urllib.error.URLError as err0:
Domoticz.Error("URL Request error: " + str(err0) + " URL: " + url)
response = ""
Domoticz.Error("URL Request error: " + str(err0) + " URL: " + url)
response = ""
except urllib.error.HTTPError as err01:
Domoticz.Error("HTTP Request error: " + str(err01) + " URL: " + url)
response = ""
Domoticz.Error("HTTP Request error: " + str(err01) + " URL: " + url)
response = ""
else:
WANip = str(response,'utf-8')
WANip = WANip.strip(' \t\n\r')

if WANip != "" and len(WANip)<16:
Domoticz.Debug("IP Discovery Site's response len is:"+ str(len(WANip)))
Domoticz.Debug("WAN IP retrieved:" + WANip)
CurWANip = Devices[1].sValue
CurWANip = CurWANip.strip(' \t\n\r')
Domoticz.Debug("Previous WAN IP:" + CurWANip)

CurMin = str(datetime.now().minute)
if len(CurMin) == 1: CurMin = "0" + CurMin

if Parameters["Mode6"] == 'Debug' and (mid(CurMin,1,1) == "3" or mid(CurMin,1,1) == "5" or mid(CurMin,1,1) == "0"):
Domoticz.Error("Debug is on. Trigering IP Change:")
CurWANip = "0.0.0.0"

if CurWANip != WANip:
Domoticz.Log("WAN IP Updated to:" + WANip)
#Devices[1].Update(2,WANip)
Devices[1].Update(2,WANip)
if Parameters["Mode3"] == 'Notify':
Domoticz.Log("Running WAN IP Notifications")
Domoticz.Debug("WAN IP retrieved:" + WANip)

ServerURL = "http://127.0.0.1:8080/json.htm?param=sendnotification&type=command"
Domoticz.Debug("ConstructedURL ServerURL is:" + ServerURL)

MailDetailsURL = "&subject=WAN-IP-Changed&body=" + WANip + "&subsystem=email"
WANip = str(response,'utf-8')
WANip = WANip.strip(' \t\n\r')


notificationURL = ServerURL + MailDetailsURL
Domoticz.Debug("ConstructedURL is:" + notificationURL)
try:
response = urllib.request.urlopen(notificationURL, timeout = 30).read()
except urllib.error.HTTPError as err1:
Domoticz.Error("HTTP Request error: " + str(err1) + " URL: " + notificationURL)
return
Domoticz.Debug("Notification URL is :" + str(notificationURL))
if WANip != "" and len(WANip)<16:
Domoticz.Debug("IP Discovery Site's response len is:"+ str(len(WANip)))
Domoticz.Debug("WAN IP retrieved:" + WANip)
CurWANip = Devices[1].sValue
CurWANip = CurWANip.strip(' \t\n\r')
Domoticz.Debug("Previous WAN IP:" + CurWANip)

CurMin = str(datetime.now().minute)
if len(CurMin) == 1: CurMin = "0" + CurMin

if Parameters["Mode6"] == 'Debug' and (mid(CurMin,1,1) == "3" or mid(CurMin,1,1) == "5" or mid(CurMin,1,1) == "0"):
Domoticz.Error("Debug is on. Trigering IP Change:")
CurWANip = "0.0.0.0"

if CurWANip != WANip:
Domoticz.Log("WAN IP Updated to:" + WANip)
#Devices[1].Update(2,WANip)
Devices[1].Update(2,WANip)

if Parameters["Mode3"] == 'Notify':
Domoticz.Log("Running WAN IP Notifications")
Domoticz.Debug("WAN IP retrieved:" + WANip)
domoticz = Parameters["Mode2"]
port = Parameters["Port"]
ServerURL = "http://" + domoticz + ":" + port + "/json.htm?type=command&param=sendnotification"
Domoticz.Debug("ConstructedURL ServerURL is:" + ServerURL)
MailDetailsURL = "&subject=WAN-IP-Changed&body=" + WANip + "&subsystem=email"
notificationURL = ServerURL + MailDetailsURL
Domoticz.Debug("ConstructedURL is:" + notificationURL)
try:
response = urllib.request.urlopen(notificationURL, timeout = 30).read()
except urllib.error.HTTPError as err1:
Domoticz.Error("HTTP Request error: " + str(err1) + " URL: " + notificationURL)
return
Domoticz.Debug("Notification URL is :" + str(notificationURL))

else:
Domoticz.Log("WAN IP the same. Skipping")
#Devices[1].Update(1,WANip, Images["wanipaddress"].ID)

elif WANip != "" and len(WANip)<40 and ':' in WANip :
Domoticz.Error("IP discovery site's response with an IPv6 result, change to example: https://api.ipify.org.")
else:
Domoticz.Log("WAN IP the same. Skipping")

#Devices[1].Update(1,WANip, Images["wanipaddress"].ID)
else:
Domoticz.Error("IP Discovery Site's response not valid")




Domoticz.Error("IP Discovery Site's response not valid")

global _plugin
_plugin = BasePlugin()
Expand All @@ -192,7 +187,6 @@ def onHeartbeat():
global _plugin
_plugin.onHeartbeat()


# Generic helper functions
def DumpConfigToLog():
for x in Parameters:
Expand All @@ -207,21 +201,15 @@ def DumpConfigToLog():
Domoticz.Debug("Device sValue: '" + Devices[x].sValue + "'")
return


#
# Parse an int and return None if no int is given
#

def parseIntValue(s):

try:
return int(s)
except:
return None

try:
return int(s)
except:
return None

def mid(s, offset, amount):
return s[offset:offset+amount]



return s[offset:offset+amount]
2 changes: 1 addition & 1 deletion upgrade.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ git reset --hard
git pull --force
sudo chmod +x plugin.py
sudo chmod +x upgrade.sh
sudo /etc/init.d/domoticz.sh restart
sudo systemctl restart domoticz.service