From 1eeb6fee6cbc4ee4d2833d8bd74c25a5a14e0aca Mon Sep 17 00:00:00 2001 From: Thyraz Date: Tue, 17 Dec 2019 21:49:21 +0100 Subject: [PATCH] Moved webhook from NUKIDevice to NUKIBridge --- 73_NUKIBridge.pm | 152 ++++++++++++++++++++++++++++++++++++++++++++- 74_NUKIDevice.pm | 158 ----------------------------------------------- 2 files changed, 151 insertions(+), 159 deletions(-) mode change 100644 => 100755 73_NUKIBridge.pm mode change 100644 => 100755 74_NUKIDevice.pm diff --git a/73_NUKIBridge.pm b/73_NUKIBridge.pm old mode 100644 new mode 100755 index 0a405f2..15863a8 --- a/73_NUKIBridge.pm +++ b/73_NUKIBridge.pm @@ -66,6 +66,8 @@ sub NUKIBridge_Define ($$); sub NUKIBridge_Undef ($$); sub NUKIBridge_Read($@); sub NUKIBridge_Attr(@); +sub NUKIBridge_addExtension($$$); +sub NUKIBridge_removeExtension($); sub NUKIBridge_Set($@); sub NUKIBridge_Get($@); sub NUKIBridge_GetCheckBridgeAlive($); @@ -73,6 +75,7 @@ sub NUKIBridge_firstRun($); sub NUKIBridge_Call($$$$$); sub NUKIBridge_Distribution($$$); sub NUKIBridge_ResponseProcessing($$$); +sub NUKIBridge_CGI(); sub NUKIBridge_Autocreate($$;$); sub NUKIBridge_InfoProcessing($$); sub NUKIBridge_getLogfile($); @@ -92,6 +95,7 @@ sub NUKIBridge_Initialize($) { $hash->{WriteFn} = "NUKIBridge_Read"; $hash->{Clients} = ":NUKIDevice:"; + my $webhookFWinstance = join( ",", devspec2array('TYPE=FHEMWEB:FILTER=TEMPORARY!=1') ); # Consumer $hash->{SetFn} = "NUKIBridge_Set"; @@ -100,6 +104,8 @@ sub NUKIBridge_Initialize($) { $hash->{UndefFn} = "NUKIBridge_Undef"; $hash->{AttrFn} = "NUKIBridge_Attr"; $hash->{AttrList} = "disable:1 ". + "webhookFWinstance:$webhookFWinstance ". + "webhookHttpHostname ". $readingFnAttributes; @@ -138,12 +144,20 @@ sub NUKIBridge_Define($$) { $hash->{VERSION} = $version; $hash->{BRIDGEAPI} = $bridgeapi; $hash->{helper}{aliveCount} = 0; + my $infix = "NUKIBridge"; Log3 $name, 3, "NUKIBridge ($name) - defined with host $host on port $port, Token $token"; $attr{$name}{room} = "NUKI" if( !defined( $attr{$name}{room} ) ); + + if ( NUKIBridge_addExtension( $name, "NUKIBridge_CGI", $infix . "-" . $host ) ) { + $hash->{fhem}{infix} = $infix; + } + + $hash->{WEBHOOK_REGISTER} = "unregistered"; + readingsSingleUpdate($hash, 'state', 'Initialized', 1 ); RemoveInternalTimer($hash); @@ -166,6 +180,10 @@ sub NUKIBridge_Undef($$) { my $host = $hash->{HOST}; my $name = $hash->{NAME}; + if ( defined( $hash->{fhem}{infix} ) ) { + NUKIBridge_removeExtension( $hash->{fhem}{infix} ); + } + RemoveInternalTimer( $hash ); delete $modules{NUKIBridge}{defptr}{$hash->{HOST}}; @@ -204,10 +222,72 @@ sub NUKIBridge_Attr(@) { Log3 $name, 3, "NUKIBridge ($name) - delete disabledForIntervals"; } } + + ###################### + #### webhook ######### + + return "Invalid value for attribute $attrName: can only by FQDN or IPv4 or IPv6 address" if ( $attrVal && $attrName eq "webhookHttpHostname" && $attrVal !~ /^([A-Za-z_.0-9]+\.[A-Za-z_.0-9]+)|[0-9:]+$/ ); + + return "Invalid value for attribute $attrName: FHEMWEB instance $attrVal not existing" if ( $attrVal && $attrName eq "webhookFWinstance" && ( !defined( $defs{$attrVal} ) || $defs{$attrVal}{TYPE} ne "FHEMWEB" ) ); + + return "Invalid value for attribute $attrName: needs to be an integer value" if ( $attrVal && $attrName eq "webhookPort" && $attrVal !~ /^\d+$/ ); + + + + + if ( $attrName =~ /^webhook.*/ ) { + + my $webhookHttpHostname = ( $attrName eq "webhookHttpHostname" ? $attrVal : AttrVal( $name, "webhookHttpHostname", "" ) ); + my $webhookFWinstance = ( $attrName eq "webhookFWinstance" ? $attrVal : AttrVal( $name, "webhookFWinstance", "" ) ); + + $hash->{WEBHOOK_URI} = "/" . AttrVal( $webhookFWinstance, "webname", "fhem" ) . "/NUKIBridge" . "-" . $hash->{HOST}; + $hash->{WEBHOOK_PORT} = ( $attrName eq "webhookPort" ? $attrVal : AttrVal( $name, "webhookPort", InternalVal( $webhookFWinstance, "PORT", "" )) ); + + $hash->{WEBHOOK_URL} = ""; + $hash->{WEBHOOK_COUNTER} = "0"; + + if ( $webhookHttpHostname ne "" && $hash->{WEBHOOK_PORT} ne "" ) { + + $hash->{WEBHOOK_URL} = "http://" . $webhookHttpHostname . ":" . $hash->{WEBHOOK_PORT} . $hash->{WEBHOOK_URI}; + my $url = "http://$webhookHttpHostname" . ":" . $hash->{WEBHOOK_PORT} . $hash->{WEBHOOK_URI}; + + Log3 $name, 3, "NUKIBridge ($name) - URL ist: $url"; + NUKIBridge_Call($hash,$hash,"callback/add",$url,undef ) if( $init_done ); + $hash->{WEBHOOK_REGISTER} = "sent"; + + } else { + $hash->{WEBHOOK_REGISTER} = "incomplete_attributes"; + } + } return undef; } +sub NUKIBridge_addExtension($$$) { + + my ( $name, $func, $link ) = @_; + my $url = "/$link"; + + Log3 $name, 2, "NUKIBridge ($name) - Registering NUKIBridge for webhook URI $url ..."; + + $data{FWEXT}{$url}{deviceName} = $name; + $data{FWEXT}{$url}{FUNC} = $func; + $data{FWEXT}{$url}{LINK} = $link; + + return 1; +} + +sub NUKIBridge_removeExtension($) { + + my ($link) = @_; + + my $url = "/$link"; + my $name = $data{FWEXT}{$url}{deviceName}; + + Log3 $name, 2, "NUKIBridge ($name) - Unregistering NUKIBridge for webhook URL $url..."; + delete $data{FWEXT}{$url}; +} + sub NUKIBridge_Set($@) { my ($hash, $name, $cmd, @args) = @_; @@ -257,7 +337,7 @@ sub NUKIBridge_Set($@) { my $id = "id=" . join( " ", @args ); my $resp = NUKIBridge_CallBlocking($hash,"callback/remove",$id) if( !IsDisabled($name) ); - if( $resp->{success} eq "true" and !IsDisabled($name) ) { + if( ($resp->{success} eq "true" or $resp->{success} == 1) and !IsDisabled($name) ) { return "Success Callback $id removed"; } else { return "remove Callback failed"; @@ -507,6 +587,72 @@ sub NUKIBridge_ResponseProcessing($$$) { return undef; } +sub NUKIBridge_CGI() { + + my ($request) = @_; + + my $hash; + my $name; + my $nukiId; + + # data received + # Testaufruf: + # curl --data '{"nukiId": 123456, "state": 1,"stateName": "locked", "batteryCritical": false}' http://10.6.6.20:8083/fhem/NUKIDevice-123456 + # wget --post-data '{"nukiId": 123456, "state": 1,"stateName": "locked", "batteryCritical": false}' http://10.6.6.20:8083/fhem/NUKIDevice-123456 + + + my $header = join("\n", @FW_httpheader); + + my ($first,$json) = split("&",$request,2); + + if( !$json ) { + Log3 $name, 3, "NUKIBridge ($name) - empty message received"; + return undef; + } elsif( $json =~ m'HTTP/1.1 200 OK' ) { + Log3 $name, 4, "NUKIBridge ($name) - empty answer received"; + return undef; + } elsif( $json !~ m/^[\[{].*[}\]]$/ ) { + Log3 $name, 3, "NUKIBridge ($name) - invalid json detected: $json"; + return "NUKIBridge ($name) - invalid json detected: $json"; + } + + my $decode_json = eval{decode_json($json)}; + if($@){ + Log3 $name, 3, "NUKIBridge ($name) - JSON error while request: $@"; + return; + } + + + if( ref($decode_json) eq "HASH" ) { + if ( defined( $modules{NUKIDevice}{defptr} ) ) { + while ( my ( $key, $value ) = each %{ $modules{NUKIDevice}{defptr} } ) { + + $hash = $modules{NUKIDevice}{defptr}{$key}; + $name = $hash->{NAME}; + $nukiId = InternalVal( $name, "NUKIID", undef ); + next if ( !$nukiId or $nukiId ne $decode_json->{nukiId} ); + + $hash->{WEBHOOK_COUNTER}++; + $hash->{WEBHOOK_LAST} = TimeNow(); + + Log3 $name, 4, "NUKIBridge ($name) - Received webhook for matching NukiId at device $name"; + + NUKIDevice_Parse($hash,$json); + } + } + + return ( undef, undef ); + } + + # no data received + else { + + Log3 undef, 4, "NUKIBridge - received malformed request\n$request"; + } + + return ( "text/plain; charset=utf-8", "Call failure: " . $request ); +} + sub NUKIBridge_Autocreate($$;$) { my ($hash,$decode_json,$force)= @_; @@ -846,6 +992,8 @@ sub NUKIBridge_CallBlocking($$$) { Attributes @@ -918,6 +1066,8 @@ sub NUKIBridge_CallBlocking($$$) { Attribute diff --git a/74_NUKIDevice.pm b/74_NUKIDevice.pm old mode 100644 new mode 100755 index d3e0ab2..c948898 --- a/74_NUKIDevice.pm +++ b/74_NUKIDevice.pm @@ -43,14 +43,11 @@ sub NUKIDevice_Initialize($); sub NUKIDevice_Define($$); sub NUKIDevice_Undef($$); sub NUKIDevice_Attr(@); -sub NUKIDevice_addExtension($$$); -sub NUKIDevice_removeExtension($); sub NUKIDevice_Set($$@); sub NUKIDevice_GetUpdate($); sub NUKIDevice_ReadFromNUKIBridge($@); sub NUKIDevice_Parse($$); sub NUKIDevice_WriteReadings($$); -sub NUKIDevice_CGI(); @@ -65,12 +62,8 @@ sub NUKIDevice_Initialize($) { $hash->{UndefFn} = "NUKIDevice_Undef"; $hash->{AttrFn} = "NUKIDevice_Attr"; - my $webhookFWinstance = join( ",", devspec2array('TYPE=FHEMWEB:FILTER=TEMPORARY!=1') ); - $hash->{AttrList} = "IODev ". "disable:1 ". - "webhookFWinstance:$webhookFWinstance ". - "webhookHttpHostname ". $readingFnAttributes; @@ -107,8 +100,6 @@ sub NUKIDevice_Define($$) { $hash->{NUKIID} = $nukiId; $hash->{VERSION} = $version; $hash->{STATE} = 'Initialized'; - my $infix = "NUKIDevice"; - AssignIoPort($hash,$iodev) if( !$hash->{IODev} ); @@ -139,14 +130,6 @@ sub NUKIDevice_Define($$) { $attr{$name}{room} = "NUKI" if( !defined( $attr{$name}{room} ) ); - if ( NUKIDevice_addExtension( $name, "NUKIDevice_CGI", $infix ) ) { - $hash->{fhem}{infix} = $infix; - } - - $hash->{WEBHOOK_REGISTER} = "unregistered"; - - - if( $init_done ) { InternalTimer( gettimeofday()+int(rand(10)), "NUKIDevice_GetUpdate", $hash, 0 ); } else { @@ -163,11 +146,6 @@ sub NUKIDevice_Undef($$) { my $nukiId = $hash->{NUKIID}; my $name = $hash->{NAME}; - - if ( defined( $hash->{fhem}{infix} ) ) { - NUKIDevice_removeExtension( $hash->{fhem}{infix} ); - } - RemoveInternalTimer($hash); my $code = $hash->{NUKIID}; @@ -208,74 +186,9 @@ sub NUKIDevice_Attr(@) { } } - ###################### - #### webhook ######### - - return "Invalid value for attribute $attrName: can only by FQDN or IPv4 or IPv6 address" if ( $attrVal && $attrName eq "webhookHttpHostname" && $attrVal !~ /^([A-Za-z_.0-9]+\.[A-Za-z_.0-9]+)|[0-9:]+$/ ); - - return "Invalid value for attribute $attrName: FHEMWEB instance $attrVal not existing" if ( $attrVal && $attrName eq "webhookFWinstance" && ( !defined( $defs{$attrVal} ) || $defs{$attrVal}{TYPE} ne "FHEMWEB" ) ); - - return "Invalid value for attribute $attrName: needs to be an integer value" if ( $attrVal && $attrName eq "webhookPort" && $attrVal !~ /^\d+$/ ); - - - - - if ( $attrName =~ /^webhook.*/ ) { - - my $webhookHttpHostname = ( $attrName eq "webhookHttpHostname" ? $attrVal : AttrVal( $name, "webhookHttpHostname", "" ) ); - my $webhookFWinstance = ( $attrName eq "webhookFWinstance" ? $attrVal : AttrVal( $name, "webhookFWinstance", "" ) ); - - $hash->{WEBHOOK_URI} = "/" . AttrVal( $webhookFWinstance, "webname", "fhem" ) . "/NUKIDevice"; - $hash->{WEBHOOK_PORT} = ( $attrName eq "webhookPort" ? $attrVal : AttrVal( $name, "webhookPort", InternalVal( $webhookFWinstance, "PORT", "" )) ); - - $hash->{WEBHOOK_URL} = ""; - $hash->{WEBHOOK_COUNTER} = "0"; - - if ( $webhookHttpHostname ne "" && $hash->{WEBHOOK_PORT} ne "" ) { - - $hash->{WEBHOOK_URL} = "http://" . $webhookHttpHostname . ":" . $hash->{WEBHOOK_PORT} . $hash->{WEBHOOK_URI} . "-" . $hash->{NUKIID}; - my $url = "http://$webhookHttpHostname" . ":" . $hash->{WEBHOOK_PORT} . $hash->{WEBHOOK_URI} . "-" . $hash->{NUKIID}; - - Log3 $name, 3, "NUKIDevice ($name) - URL ist: $url"; - NUKIDevice_ReadFromNUKIBridge($hash,"callback/add",$url,undef ) if( $init_done ); - $hash->{WEBHOOK_REGISTER} = "sent"; - - } else { - $hash->{WEBHOOK_REGISTER} = "incomplete_attributes"; - } - } - return undef; } -sub NUKIDevice_addExtension($$$) { - - my ( $name, $func, $link ) = @_; - my $url = "/$link"; - - - return 0 if ( defined( $data{FWEXT}{$url} ) && $data{FWEXT}{$url}{deviceName} ne $name ); - - Log3 $name, 2, "NUKIDevice ($name) - Registering NUKIDevice for webhook URI $url ..."; - - $data{FWEXT}{$url}{deviceName} = $name; - $data{FWEXT}{$url}{FUNC} = $func; - $data{FWEXT}{$url}{LINK} = $link; - - return 1; -} - -sub NUKIDevice_removeExtension($) { - - my ($link) = @_; - - my $url = "/$link"; - my $name = $data{FWEXT}{$url}{deviceName}; - - Log3 $name, 2, "NUKIDevice ($name) - Unregistering NUKIDevice for webhook URL $url..."; - delete $data{FWEXT}{$url}; -} - sub NUKIDevice_Set($$@) { my ($hash, $name, @aa) = @_; @@ -499,73 +412,6 @@ sub NUKIDevice_WriteReadings($$) { return undef; } -sub NUKIDevice_CGI() { - - my ($request) = @_; - - my $hash; - my $name; - my $nukiId; - - - # data received - # Testaufruf: - # curl --data '{"nukiId": 123456, "state": 1,"stateName": "locked", "batteryCritical": false}' http://10.6.6.20:8083/fhem/NUKIDevice-123456 - # wget --post-data '{"nukiId": 123456, "state": 1,"stateName": "locked", "batteryCritical": false}' http://10.6.6.20:8083/fhem/NUKIDevice-123456 - - - my $header = join("\n", @FW_httpheader); - - my ($first,$json) = split("&",$request,2); - - if( !$json ) { - Log3 $name, 3, "NUKIDevice ($name) - empty answer received"; - return undef; - } elsif( $json =~ m'HTTP/1.1 200 OK' ) { - Log3 $name, 4, "NUKIDevice ($name) - empty answer received"; - return undef; - } elsif( $json !~ m/^[\[{].*[}\]]$/ ) { - Log3 $name, 3, "NUKIDevice ($name) - invalid json detected: $json"; - return "NUKIDevice ($name) - invalid json detected: $json"; - } - - my $decode_json = eval{decode_json($json)}; - if($@){ - Log3 $name, 3, "NUKIDevice ($name) - JSON error while request: $@"; - return; - } - - - if( ref($decode_json) eq "HASH" ) { - if ( defined( $modules{NUKIDevice}{defptr} ) ) { - while ( my ( $key, $value ) = each %{ $modules{NUKIDevice}{defptr} } ) { - - $hash = $modules{NUKIDevice}{defptr}{$key}; - $name = $hash->{NAME}; - $nukiId = InternalVal( $name, "NUKIID", undef ); - next if ( !$nukiId or $nukiId ne $decode_json->{nukiId} ); - - $hash->{WEBHOOK_COUNTER}++; - $hash->{WEBHOOK_LAST} = TimeNow(); - - Log3 $name, 4, "NUKIDevice ($name) - Received webhook for matching NukiId at device $name"; - - NUKIDevice_Parse($hash,$json); - } - } - - return ( undef, undef ); - } - - # no data received - else { - - Log3 undef, 4, "NUKIDevice - received malformed request\n$request"; - } - - return ( "text/plain; charset=utf-8", "Call failure: " . $request ); -} - @@ -636,8 +482,6 @@ sub NUKIDevice_CGI() { Attributes @@ -697,8 +541,6 @@ sub NUKIDevice_CGI() { Attribute