#########################################################################
# $Id$
# fhem Modul für Geräte mit Web-Oberfläche
#
# This file is part of fhem.
#
# Fhem is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 2 of the License, or
# (at your option) any later version.
#
# Fhem is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with fhem. If not, see .
#
##############################################################################
# Changelog:
#
# 2013-12-25 initial version
# 2013-12-29 modified to use non blocking HTTP
# 2014-1-1 modified to use attr instead of set to define internal parameters
# 2014-1-6 extended error handling and added documentation
# 2014-1-15 added readingsExpr to allow some computation on raw values before put in readings
# 2014-3-13 added noShutdown and disable attributes
# 2014-4-8 fixed noShutdown check
# 2014-4-9 added Attribute timeout as suggested by Frank
# 2014-10-22 added generic set function, alternative naming of old attributes, ...
# 2014-11-17 added queueing for requests, fixed timeout
# 2014-11-30 fixed race condition, added ignoreRedirects
# an neues HttpUtils angepasst
# 2014-12-05 definierte Attribute werden zu userattr der Instanz hinzugefügt
# use $hash->{HTTPHEADER} or $hash->{httpheader}
# 2014-12-22 Warnung in Set korrigiert
# 2015-02-11 added attributes for a generic get feature, new get function, attributes "map" for readings,
# modified the map attributes handling so it works with strings containing blanks
# and splits at ", " or ":"
# 2015-02-15 attribute to select readings per get
# 2015-02-17 new attributes getXXRegex, Map, Format, Expr, new semantics for default values of these attributes
# restructured HTTPMOD_Read
# 2015-04-27 Integrated modification of jowiemann partially
# settings: interval, reread, stop, start
# DEVSTATE was not implemented because "disabled" is visible as attribute
# and stopped / started is visible as TRIGGERTIME.
# also the attribute disabled will not touch the internal timer.
# 2015-05-10 Integrated xpath extension as suggested in the forum
# 2015-06-22 added set[0-9]*NoArg and get[0-9]*URLExpr, get[0-9]*HeaderExpr and get[0-9]*DataExpr
# 2015-07-30 added set[0-9]*TextArg, Encode and Decode
# 2015-08-03 added get[0-9]*PullToFile (not fully implemented yet and not yet documented)
# 2015-08-24 corrected bug when handling sidIdRegex for step <> 1
# 2015-09-14 implemented parseFunction1 and 2, modified to not return a value if successful
# 2015-10-10 major restructuring, new xpath, xpath-strict and json parsing implementation
# 2015-11-08 fixed bug which caused a recursion when reading from file:// urls
# fixed xpath handling (so far ...)
# 2015-11-19 MaxAge, aligned type and context for some functions
# 2015-11-23 fixed map handling to allow spaces in names and convert them for fhemweb
# 2015-12-03 Max age finalized
# 2015-12-05 fixed error when loading Libs inside eval{} (should have been eval"") and added documentation for showError
# 2015-12-07 fixed syntax to work with Perl older than 5.14 in a few places
# added RecombineExpr and a few performance optimisations
# 2015-12-10 fixed a bug in JSON parsing and corrected extractAllJSON to start with lower case
# 2015-12-22 fixed missing error handling for JSON parser call
# 2015-12-28 added SetParseResponse
# 2016-01-01 fixed bug where httpheader was not handled, added cookie handling
# 2016-01-09 fixed a bug which caused only one replacement per string to happen
# 2016-01-10 fixed a bug where only the first word of text passed to set is used,
# added sid extraction and reAuth detection with JSON and XPath
# 2016-01-11 modified automatic $val replacement for set values to pass the value through the request queue and
# do the actual replacement just before sending just like user definable replacements
# so they can be done by replacement attributes with other placeholders instead
# 2016-01-16 added TextArg to get and optimized creating the hint list for get / set ?
# 2016-01-21 added documentation
# added RegOpt (still needs more testing), Replacement mode delete
# 2016-01-23 changed MATCHED_READINGS to contain automatically created subreadings (-num)
# added AutoNumLen for automatic sub-reading names (multiple matches) so the number has leading zeros and a fixed length
# added new attribute upgrading mechanism (e.g. for sidIDRegex to sidIdRegex)
# 2016-01-25 modified the way attributes are added to userattr - now includes :hints for fhemweb and old entries are replaced
# 2016-02-02 added more checks to JsonFlatter (if defined ...), fixed auth to be added in the front of the queue, added clearSIdBeforeAuth, authRetries
# 2016-02-04 added a feature to name a reading "unnamed-XX" if Name attribute is missing instead of ignoring everything related
# 2016-02-05 fixed a warning caused by missing initialisation of .setList internal
# 2016-02-07 allowed more regular expression modifiers in RegOpt, added IMap / OMap / IExpr / OExpr
# 2016-02-13 enable sslVersion attribute für HttpUtils and httpVersion
# 2016-02-14 add sslArgs attribute - e.g. as attr myDevice sslArgs SSL_verify_mode,SSL_VERIFY_NONE
# Log old attrs and offer set upgradeAttributes
# 2016-02-15 added replacement type key and set storeKeyValue
# 2016-02-20 set $XML::XPath::SafeMode = 1 to avoid memory leak in XML parser lib
#
# Todo:
# replacement scope attribute
# Implement IMap und IExpr for get
#
# doku der wichtigsten internen Strukturen (z.B. Request auch für Replacements und für Parse-Funktionen
# make axtracting the sid after a get / update an attribute / option
#
# multi page log extraction
# Profiling von Modbus übernehmen?
#
# extend httpmod to support simple tcp connections aver devio instead of HttpUtils
# extend devio for non blocking connect like httputils
#
#
package main;
use strict;
use warnings;
use Time::HiRes qw(gettimeofday);
use Encode qw(decode encode);
use HttpUtils;
sub HTTPMOD_Initialize($);
sub HTTPMOD_Define($$);
sub HTTPMOD_Undef($$);
sub HTTPMOD_Set($@);
sub HTTPMOD_Get($@);
sub HTTPMOD_Attr(@);
sub HTTPMOD_GetUpdate($);
sub HTTPMOD_Read($$$);
sub HTTPMOD_AddToQueue($$$$$;$$$$);
sub HTTPMOD_JsonFlatter($$;$);
sub HTTPMOD_ExtractReading($$$$);
#
# FHEM module intitialisation
# defines the functions to be called from FHEM
#########################################################################
sub HTTPMOD_Initialize($)
{
my ($hash) = @_;
$hash->{DefFn} = "HTTPMOD_Define";
$hash->{UndefFn} = "HTTPMOD_Undef";
$hash->{SetFn} = "HTTPMOD_Set";
$hash->{GetFn} = "HTTPMOD_Get";
$hash->{AttrFn} = "HTTPMOD_Attr";
$hash->{AttrList} =
"(reading|get|set)[0-9]+(-[0-9]+)?Name " .
"(reading|get|set)[0-9]*(-[0-9]+)?Expr " .
"(reading|get|set)[0-9]*(-[0-9]+)?Map " .
"(reading|get|set)[0-9]*(-[0-9]+)?OExpr " .
"(reading|get|set)[0-9]*(-[0-9]+)?OMap " .
"(get|set)[0-9]*(-[0-9]+)?IExpr " .
"(get|set)[0-9]*(-[0-9]+)?IMap " .
"(reading|get|set)[0-9]*(-[0-9]+)?Format " .
"(reading|get|set)[0-9]*(-[0-9]+)?Decode " .
"(reading|get|set)[0-9]*(-[0-9]+)?Encode " .
"(reading|get)[0-9]*(-[0-9]+)?MaxAge " .
"(reading|get)[0-9]*(-[0-9]+)?MaxAgeReplacementMode:text,expression,delete " .
"(reading|get)[0-9]*(-[0-9]+)?MaxAgeReplacement " .
"(reading|get|set)[0-9]+Regex " .
"(reading|get|set)[0-9]+RegOpt " . # see http://perldoc.perl.org/perlre.html#Modifiers
"(reading|get|set)[0-9]+XPath " .
"(reading|get|set)[0-9]+XPath-Strict " .
"(reading|get|set)[0-9]+JSON " .
"(reading|get|set)[0-9]*RecombineExpr " .
"(reading|get|set)[0-9]*AutoNumLen " .
"extractAllJSON " .
"readingsName.* " . # old
"readingsRegex.* " . # old
"readingsExpr.* " . # old
"requestHeader.* " .
"requestData.* " .
"noShutdown:0,1 " .
"httpVersion " .
"sslVersion " .
"sslArgs " .
"timeout " .
"queueDelay " .
"queueMax " .
"minSendDelay " .
"showMatched:0,1 " .
"showError:0,1 " .
"parseFunction1 " .
"parseFunction2 " .
"[gs]et[0-9]*URL " .
"[gs]et[0-9]*Data.* " .
"[gs]et[0-9]*NoData.* " . # make sure it is an HTTP GET without data - even if a more generic data is defined
"[gs]et[0-9]*Header.* " .
"[gs]et[0-9]*CheckAllReadings:0,1 " .
"[gs]et[0-9]*ExtractAllJSON:0,1 " .
"[gs]et[0-9]*URLExpr " . # old
"[gs]et[0-9]*DatExpr " . # old
"[gs]et[0-9]*HdrExpr " . # old
"get[0-9]+Poll:0,1 " .
"get[0-9]+PollDelay " .
"get[0-9]*PullToFile " .
"get[0-9]*PullIterate " .
"set[0-9]+Min " . # todo: min, max und hint auch für get, Schreibweise der Liste auf (get|set) vereinheitlichen
"set[0-9]+Max " .
"set[0-9]+Hint " . # Direkte Fhem-spezifische Syntax für's GUI, z.B. "6,10,14" bzw. slider etc.
"set[0-9]*NoArg:0,1 " . # don't expect a value - for set on / off and similar. (default for get)
"[gs]et[0-9]*TextArg:0,1 " . # just pass on a raw text value without validation / further conversion
"set[0-9]*ParseResponse:0,1 " . # parse response to set as if it was a get
"reAuthRegex " .
"reAuthJSON " .
"reAuthXPath " .
"reAuthXPath-Strict " .
"[gs]et[0-9]*ReAuthRegex " .
"[gs]et[0-9]*ReAuthJSON " .
"[gs]et[0-9]*ReAuthXPath " .
"[gs]et[0-9]*ReAuthXPath-Strict " .
"idRegex " .
"idJSON " .
"idXPath " .
"idXPath-Strict " .
"(get|set|sid)[0-9]*IDRegex " . # old
"(get|set|sid)[0-9]*IdRegex " .
"(get|set|sid)[0-9]*IdJSON " .
"(get|set|sid)[0-9]*IdXPath " .
"(get|set|sid)[0-9]*IdXPath-Strict " .
"sid[0-9]*URL " .
"sid[0-9]*Header.* " .
"sid[0-9]*Data.* " .
"sid[0-9]*IgnoreRedirects:0,1 " .
"sid[0-9]*ParseResponse:0,1 " . # parse response as if it was a get
"clearSIdBeforeAuth:0,1 " .
"authRetries " .
"replacement[0-9]*Regex " .
"replacement[0-9]*Mode:reading,internal,text,expression,key " . # defaults to text
"replacement[0-9]*Value " . # device:reading, device:internal, text, replacement expression
"[gs]et[0-9]*Replacement[0-9]*Value " . # can overwrite a global replacement value - todo: auch für auth?
"do_not_notify:1,0 " .
"disable:0,1 " .
"enableControlSet:0,1 " .
"enableCookies:0,1 " .
"enableXPath:0,1 " . # old
"enableXPath-Strict:0,1 " . # old
$readingFnAttributes;
}
#
# Define command
# init internal values,
# set internal timer get Updates
#########################################################################
sub HTTPMOD_Define($$)
{
my ($hash, $def) = @_;
my @a = split( "[ \t]+", $def );
return "wrong syntax: define HTTPMOD URL interval"
if ( @a < 3 );
my $name = $a[0];
if ($a[2] eq "none") {
Log3 $name, 3, "$name: URL is none, no periodic updates will be limited to explicit GetXXPoll attribues (if defined)";
$hash->{MainURL} = "";
} else {
$hash->{MainURL} = $a[2];
}
if(int(@a) > 3) {
# interval specified
if ($a[3] > 0) {
if ($a[3] >= 5) {
$hash->{Interval} = $a[3];
} else {
return "interval too small, please use something > 5, default is 300";
}
} else {
Log3 $name, 3, "$name: interval is 0, no periodic updates will done.";
$hash->{Interval} = 0;
}
} else {
# default if no interval specified
$hash->{Interval} = 300;
}
Log3 $name, 3, "$name: Defined " .
($hash->{MainURL} ? "with URL $hash->{MainURL}" : "without URL") .
($hash->{Interval} ? " and interval $hash->{Interval}" : "");
# Initial request after 2 secs, for further updates the timer will be set according to interval.
# but only if URL is specified and interval > 0
if ($hash->{MainURL} && $hash->{Interval}) {
my $firstTrigger = gettimeofday() + 2;
$hash->{TRIGGERTIME} = $firstTrigger;
$hash->{TRIGGERTIME_FMT} = FmtDateTime($firstTrigger);
RemoveInternalTimer("update:$name");
InternalTimer($firstTrigger, "HTTPMOD_GetUpdate", "update:$name", 0);
Log3 $name, 5, "$name: InternalTimer set to call GetUpdate in 2 seconds for the first time";
} else {
$hash->{TRIGGERTIME} = 0;
$hash->{TRIGGERTIME_FMT} = "";
}
$hash->{".getList"} = "";
$hash->{".setList"} = "";
return undef;
}
#
# undefine command when device is deleted
#########################################################################
sub HTTPMOD_Undef($$)
{
my ($hash, $arg) = @_;
my $name = $hash->{NAME};
RemoveInternalTimer ("timeout:$name");
RemoveInternalTimer ("queue:$name");
RemoveInternalTimer ("update:$name");
return undef;
}
#########################################################################
sub HTTPMOD_LogOldAttr($$;$)
{
my ($hash, $old, $new) = @_;
my $name = $hash->{NAME};
Log3 $name, 3, "$name: the attribute $old should no longer be used." . ($new ? " Please use $new instead" : "");
Log3 $name, 3, "$name: For most old attributes you can specify enableControlSet and then set device upgradeAttributes to automatically modify the configuration";
}
#
# Attr command
#########################################################################
sub HTTPMOD_Attr(@)
{
my ($cmd,$name,$aName,$aVal) = @_;
my $hash = $defs{$name};
my $modHash = $modules{$hash->{TYPE}};
my ($sid, $old); # might be needed inside a URLExpr
# $cmd can be "del" or "set"
# $name is device name
# aName and aVal are attribute name and attribute value
# simple attributes like requestHeader and requestData need no special treatment here
# readingsExpr, readingsRegex.* or reAuthRegex need validation though.
# if validation fails, return something so CommandAttr in fhem.pl doesn't assign a value to $attr
if ($cmd eq "set") {
if ($aName =~ /Regex/) { # catch all Regex like attributes
eval {qr/$aVal/};
if ($@) {
Log3 $name, 3, "$name: Attr with invalid regex in attr $name $aName $aVal: $@";
return "Invalid Regex $aVal";
}
if ($aName =~ /([gs]et[0-9]*)?[Rr]eplacement[0-9]*Regex$/) {
$hash->{ReplacementEnabled} = 1;
}
# conversions for legacy things
if ($aName =~ /(.+)IDRegex$/) {
HTTPMOD_LogOldAttr($hash, $aName, "${1}IdRegex");
}
if ($aName =~ /readingsRegex.*/) {
HTTPMOD_LogOldAttr($hash, $aName, "reading01Regex syntax");
}
} elsif ($aName =~ /readingsName.*/) {
HTTPMOD_LogOldAttr($hash, $aName, "reading01Name syntax");
} elsif ($aName =~ /RegOpt$/) {
if ($aVal !~ /^[msxdualsig]*$/) {
Log3 $name, 3, "$name: illegal RegOpt in attr $name $aName $aVal";
return "$name: illegal RegOpt in attr $name $aName $aVal";
}
} elsif ($aName =~ /Expr/) { # validate all Expressions
my $val = 0;
my @matchlist = ();
no warnings qw(uninitialized);
eval $aVal;
if ($@) {
Log3 $name, 3, "$name: Attr with invalid Expression in attr $name $aName $aVal: $@";
return "Invalid Expression $aVal";
}
if ($aName =~ /readingsExpr.*/) {
HTTPMOD_LogOldAttr($hash, $aName, "reading01Expr syntax");
} elsif ($aName =~ /^(get[0-9]*)Expr/) {
HTTPMOD_LogOldAttr($hash, $aName, "${1}OExpr");
} elsif ($aName =~ /^(reading[0-9]*)Expr/) {
HTTPMOD_LogOldAttr($hash, $aName, "${1}OExpr");
} elsif ($aName =~ /^(set[0-9]*)Expr/) {
HTTPMOD_LogOldAttr($hash, $aName, "${1}IExpr");
}
} elsif ($aName =~ /Map$/) {
if ($aName =~ /^(get[0-9]*)Map/) {
HTTPMOD_LogOldAttr($hash, $aName, "${1}OMap");
} elsif ($aName =~ /^(reading[0-9]*)Map/) {
HTTPMOD_LogOldAttr($hash, $aName, "${1}OMap");
} elsif ($aName =~ /^(set[0-9]*)Map/) {
HTTPMOD_LogOldAttr($hash, $aName, "${1}IMap");
}
} elsif ($aName =~ /replacement[0-9]*Mode/) {
if ($aVal !~ /^(reading|internal|text|expression|key)$/) {
Log3 $name, 3, "$name: illegal mode in attr $name $aName $aVal";
return "$name: illegal mode in attr $name $aName $aVal";
}
} elsif ($aName =~ /([gs]et[0-9]*)?[Rr]eplacement([0-9]*)Value/) {
Log3 $name, 5, "$name: validating attr $name $aName $aVal";
if (AttrVal($name, "replacement${2}Mode", "text") eq "expression") {
no warnings qw(uninitialized);
eval $aVal;
if ($@) {
Log3 $name, 3, "$name: Attr with invalid Expression (mode is expression) in attr $name $aName $aVal: $@";
return "Attr with invalid Expression (mode is expression) in attr $name $aName $aVal: $@";
}
}
} elsif ($aName =~ /(get|reading)[0-9]*JSON$/
|| $aName =~ /[Ee]xtractAllJSON$/
|| $aName =~ /[Rr]eAuthJSON$/
|| $aName =~ /[Ii]dJSON$/) {
eval "use JSON";
if($@) {
# Log3 $name, 3, "$name: Please install JSON Library to use JSON (apt-get install libjson-perl) - error was $@";
return "Please install JSON Library to use JSON (apt-get install libjson-perl) - error was $@";
}
$hash->{JSONEnabled} = 1;
} elsif ($aName eq "enableCookies") {
if ($aVal eq "0") {
delete $hash->{HTTPCookieHash};
delete $hash->{HTTPCookies};
}
} elsif ($aName eq "enableXPath"
|| $aName =~ /(get|reading)[0-9]+XPath$/
|| $aName =~ /[Rr]eAuthXPath$/
|| $aName =~ /[Ii]dXPath$/) {
eval "use HTML::TreeBuilder::XPath";
if($@) {
# Log3 $name, 3, "$name: Please install HTML::TreeBuilder::XPath to use the xpath-Option (apt-get install libxml-TreeBuilder-perl libhtml-treebuilder-xpath-perl) - error was $@";
return "Please install HTML::TreeBuilder::XPath to use the xpath-Option (apt-get install libxml-TreeBuilder-perl libhtml-treebuilder-xpath-perl) - error was $@";
}
$hash->{XPathEnabled} = 1;
} elsif ($aName eq "enableXPath-Strict"
|| $aName =~ /(get|reading)[0-9]+XPath-Strict$/
|| $aName =~ /[Rr]eAuthXPath-Strict$/
|| $aName =~ /[Ii]dXPath-Strict$/) {
eval "use XML::XPath;use XML::XPath::XMLParser";
if($@) {
#Log3 $name, 3, "$name: Please install XML::XPath and XML::XPath::XMLParser to use the xpath-strict-Option (apt-get install libxml-parser-perl libxml-xpath-perl) - error was $@";
return "Please install XML::XPath and XML::XPath::XMLParser to use the xpath-strict-Option (apt-get install libxml-parser-perl libxml-xpath-perl) - error was $@";
}
$XML::XPath::SafeMode = 1;
$hash->{XPathStrictEnabled} = 1;
} elsif ($aName =~ /^(reading|get)[0-9]*(-[0-9]+)?MaxAge$/) {
if ($aVal !~ '([0-9]+)') {
Log3 $name, 3, "$name: wrong format in attr $name $aName $aVal";
return "Invalid Format $aVal in $aName";
}
$hash->{MaxAgeEnabled} = 1;
} elsif ($aName =~ /^(reading|get)[0-9]*(-[0-9]+)?MaxAgeReplacementMode$/) {
if ($aVal !~ /^(text|expression|delete)$/) {
Log3 $name, 3, "$name: illegal mode in attr $name $aName $aVal";
return "$name: illegal mode in attr $name $aName $aVal, choose on of text, expression";
}
} elsif ($aName =~ /^(reading|get)([0-9]+)(-[0-9]+)?Name$/) {
$hash->{defptr}{readingBase}{$aVal} = $1;
$hash->{defptr}{readingNum}{$aVal} = $2 if ($2);
$hash->{defptr}{readingSubNum}{$aVal} = $3 if ($3);
}
# handle wild card attributes -> Add to userattr to allow modification in fhemweb
#Log3 $name, 3, "$name: attribute $aName checking ";
if (" $modHash->{AttrList} " !~ m/ ${aName}[ :;]/) {
# nicht direkt in der Liste -> evt. wildcard attr in AttrList
foreach my $la (split " ", $modHash->{AttrList}) {
$la =~ /([^:;]+)(:?.*)/;
my $vgl = $1; # attribute name in list - probably a regex
my $opt = $2; # attribute hint in list
if ($aName =~ $vgl) { # yes - the name in the list now matches as regex
# $aName ist eine Ausprägung eines wildcard attrs
#Log3 $name, 3, "$name: attribute $aName specified from $vgl, add to userattr" .
# ($opt ? " with extension $opt" : "");
addToDevAttrList($name, "$aName" . $opt); # create userattr with hint to allow changing by click in fhemweb
if ($opt) {
# remove old entries without hint
my $ualist = $attr{$name}{userattr};
$ualist = "" if(!$ualist);
my %uahash;
foreach my $a (split(" ", $ualist)) {
if ($a !~ /^${aName}$/) { # entry in userattr list is attribute without hint
$uahash{$a} = 1;
} else {
Log3 $name, 3, "$name: added hint $opt to attr $a in userattr list";
}
}
$attr{$name}{userattr} = join(" ", sort keys %uahash);
}
}
}
} else {
# exakt in Liste enthalten -> sicherstellen, dass keine +* etc. drin sind.
if ($aName =~ /\|\*\+\[/) {
Log3 $name, 3, "$name: Atribute $aName is not valid. It still contains wildcard symbols";
return "$name: Atribute $aName is not valid. It still contains wildcard symbols";
}
}
# Deletion of Attributes
} elsif ($cmd eq "del") {
#Log3 $name, 5, "$name: del attribute $aName";
if ($aName =~ /(reading|get)[0-9]*JSON$/
|| $aName =~ /[Ee]xtractAllJSON$/
|| $aName =~ /[Rr]eAuthJSON$/
|| $aName =~ /[Ii]dJSON$/) {
if (!(grep !/$aName/, grep (/((reading|get)[0-9]*JSON$)|[Ee]xtractAllJSON$|[Rr]eAuthJSON$|[Ii]dJSON$/,
keys %{$attr{$name}}))) {
delete $hash->{JSONEnabled};
#Log3 $name, 5, "$name: disable JSON";
}
} elsif ($aName eq "enableXPath"
|| $aName =~ /(get|reading)[0-9]+XPath$/
|| $aName =~ /[Rr]eAuthXPath$/
|| $aName =~ /[Ii]dXPath$/) {
if (!(grep !/$aName/, grep (/(get|reading)[0-9]+XPath$|enableXPath|[Rr]eAuthXPath$|[Ii]dXPath$/,
keys %{$attr{$name}}))) {
delete $hash->{XPathEnabled};
#Log3 $name, 5, "$name: disable XPath";
}
} elsif ($aName eq "enableXPath-Strict"
|| $aName =~ /(get|reading)[0-9]+XPath-Strict$/
|| $aName =~ /[Rr]eAuthXPath-Strict$/
|| $aName =~ /[Ii]dXPath-Strict$/) {
if (!(grep !/$aName/, grep (/(get|reading)[0-9]+XPath-Strict$|enableXPath-Strict|[Rr]eAuthXPath-Strict$|[Ii]dXPath-Strict$/,
keys %{$attr{$name}}))) {
delete $hash->{XPathStrictEnabled};
#Log3 $name, 5, "$name: disable XPathStrict";
}
} elsif ($aName eq "enableCookies") {
delete $hash->{HTTPCookieHash};
delete $hash->{HTTPCookies};
} elsif ($aName =~ /(reading|get)[0-9]*(-[0-9]+)?MaxAge$/) {
if (!(grep !/$aName/, grep (/(reading|get)[0-9]*(-[0-9]+)?MaxAge$/, keys %{$attr{$name}}))) {
delete $hash->{MaxAgeEnabled};
#Log3 $name, 5, "$name: disable MaxAge";
}
} elsif ($aName =~ /([gs]et[0-9]*)?[Rr]eplacement[0-9]*Regex/) {
if (!(grep !/$aName/, grep (/([gs]et[0-9]*)?[Rr]eplacement[0-9]*Regex/, keys %{$attr{$name}}))) {
delete $hash->{ReplacementEnabled};
#Log3 $name, 5, "$name: disable Replacement";
}
}
}
if ($aName =~ /^[gs]et/ || $aName eq "enableControlSet") {
$hash->{".updateHintList"} = 1;
}
if ($aName =~ /^(get|reading)/) {
$hash->{".updateReadingList"} = 1;
}
return undef;
}
# Upgrade attribute names from older versions
##############################################
sub HTTPMOD_UpgradeAttributes($)
{
my ($hash) = @_;
my $name = $hash->{NAME};
my %dHash;
my %numHash;
#Log3 $name, 3, "$name: UpgradeAttributes called, userattr list is $attr{$name}{userattr}";
foreach my $aName (keys %{$attr{$name}}) {
if ($aName =~ /(.+)IDRegex$/) {
my $new = $1 . "IdRegex";
my $val = $attr{$name}{$aName};
CommandAttr(undef, "$name $new $val"); # also adds new attr to userattr list through _Attr function
CommandDeleteAttr(undef, "$name $aName");
$dHash{$aName} = 1;
Log3 $name, 3, "$name: upgraded attribute name $aName to new sytax $new";
} elsif ($aName =~ /(.+)Regex$/) {
my $ctx = $1;
my $val = $attr{$name}{$aName};
#Log3 $name, 3, "$name: upgradeAttributes check attr $aName, val $val";
if ($val =~ /^xpath:(.*)/) {
$val = $1;
my $new = $ctx . "XPath";
CommandAttr(undef, "$name $new $val");
CommandAttr(undef, "$name $ctx" . "RecombineExpr join(\",\", \@matchlist)");
CommandDeleteAttr(undef, "$name $aName");
$dHash{$aName} = 1;
Log3 $name, 3, "$name: upgraded attribute name $aName to new sytax $new";
}
if ($val =~ /^xpath-strict:(.*)/) {
$val = $1;
my $new = $ctx . "XPath-Strict";
CommandAttr(undef, "$name $new $val");
CommandAttr(undef, "$name $ctx" . "RecombineExpr join(\",\", \@matchlist)");
CommandDeleteAttr(undef, "$name $aName");
$dHash{$aName} = 1;
Log3 $name, 3, "$name: upgraded attribute name $aName to new sytax $new";
}
} elsif ($aName eq "enableXPath" || $aName eq "enableXPath-Strict" ) {
CommandDeleteAttr(undef, "$name $aName");
Log3 $name, 3, "$name: removed attribute name $aName";
} elsif ($aName =~ /(set[0-9]*)Expr$/) {
my $new = $1 . "IExpr";
my $val = $attr{$name}{$aName};
CommandAttr(undef, "$name $new $val");
CommandDeleteAttr(undef, "$name $aName");
$dHash{$aName} = 1;
Log3 $name, 3, "$name: upgraded attribute name $aName to new sytax $new";
} elsif ($aName =~ /(get[0-9]*)Expr$/) {
my $new = $1 . "OExpr";
my $val = $attr{$name}{$aName};
CommandAttr(undef, "$name $new $val");
CommandDeleteAttr(undef, "$name $aName");
$dHash{$aName} = 1;
Log3 $name, 3, "$name: upgraded attribute name $aName to new sytax $new";
} elsif ($aName =~ /(reading[0-9]*)Expr$/) {
my $new = $1 . "OExpr";
my $val = $attr{$name}{$aName};
CommandAttr(undef, "$name $new $val");
CommandDeleteAttr(undef, "$name $aName");
$dHash{$aName} = 1;
Log3 $name, 3, "$name: upgraded attribute name $aName to new sytax $new";
} elsif ($aName =~ /(set[0-9]*)Map$/) {
my $new = $1 . "IMap";
my $val = $attr{$name}{$aName};
CommandAttr(undef, "$name $new $val");
CommandDeleteAttr(undef, "$name $aName");
$dHash{$aName} = 1;
Log3 $name, 3, "$name: upgraded attribute name $aName to new sytax $new";
} elsif ($aName =~ /(get[0-9]*)Map$/) {
my $new = $1 . "OMap";
my $val = $attr{$name}{$aName};
CommandAttr(undef, "$name $new $val");
CommandDeleteAttr(undef, "$name $aName");
$dHash{$aName} = 1;
Log3 $name, 3, "$name: upgraded attribute name $aName to new sytax $new";
} elsif ($aName =~ /(reading[0-9]*)Map$/) {
my $new = $1 . "OMap";
my $val = $attr{$name}{$aName};
CommandAttr(undef, "$name $new $val");
CommandDeleteAttr(undef, "$name $aName");
$dHash{$aName} = 1;
Log3 $name, 3, "$name: upgraded attribute name $aName to new sytax $new";
} elsif ($aName =~ /^readings(Name|Expr|Regex)(.*)$/) {
my $typ = $1;
my $sfx = $2;
my $num;
if (defined($numHash{$sfx})) {
$num = $numHash{$sfx};
} else {
my $max = 0;
foreach my $a (keys %{$attr{$name}}) {
if ($a =~ /^reading([0-9]+)\D+$/) {
$max = $1 if ($1 > $max);
}
}
$num = sprintf("%02d", $max + 1);
$numHash{$sfx} = $num;
}
my $new = "reading${num}${typ}";
my $val = $attr{$name}{$aName};
CommandAttr(undef, "$name $new $val");
CommandDeleteAttr(undef, "$name $aName");
$dHash{$aName} = 1;
Log3 $name, 3, "$name: upgraded attribute name $aName to new sytax $new";
}
}
$dHash{"enableXpath"} = 1;
$dHash{"enableXpath-Strict"} = 1;
my $ualist = $attr{$name}{userattr};
$ualist = "" if(!$ualist);
my %uahash;
foreach my $a (split(" ", $ualist)) {
if (!$dHash{$a}) {
$uahash{$a} = 1;
#Log3 $name, 3, "$name: keeping $a in userattr list";
} else {
Log3 $name, 3, "$name: dropping $a from userattr list";
}
}
$attr{$name}{userattr} = join(" ", sort keys %uahash);
#Log3 $name, 3, "$name: UpgradeAttribute done, userattr list is $attr{$name}{userattr}";
}
# get attribute based specification
# for format, map or similar
# with generic and absolute default (empty variable num part)
# if num is like 1-1 then check for 1 if 1-1 not found
#############################################################
sub HTTPMOD_GetFAttr($$$$;$)
{
my ($name, $prefix, $num, $type, $val) = @_;
# first look for attribute with the full num in it
if (defined ($attr{$name}{$prefix . $num . $type})) {
$val = $attr{$name}{$prefix . $num . $type};
# if not found then check if num contains a subnum (for regexes with multiple capture groups etc) and look for attribute without this subnum
} elsif (($num =~ /([0-9]+)-[0-9]+/) && defined ($attr{$name}{$prefix .$1 . $type})) {
$val = $attr{$name}{$prefix . $1 . $type};
# if again not found then look for generic attribute without num
} elsif (defined ($attr{$name}{$prefix . $type})) {
$val = $attr{$name}{$prefix . $type};
}
return $val;
}
###################################################
# checks and stores obfuscated keys like passwords
# based on / copied from FRITZBOX_storePassword
sub HTTPMOD_StoreKeyValue($$$)
{
my ($hash, $kName, $value) = @_;
my $index = $hash->{TYPE}."_".$hash->{NAME}."_".$kName;
my $key = getUniqueId().$index;
my $enc = "";
if(eval "use Digest::MD5;1")
{
$key = Digest::MD5::md5_hex(unpack "H*", $key);
$key .= Digest::MD5::md5_hex($key);
}
for my $char (split //, $value)
{
my $encode=chop($key);
$enc.=sprintf("%.2x",ord($char)^ord($encode));
$key=$encode.$key;
}
my $err = setKeyValue($index, $enc);
return "error while saving the value - $err" if(defined($err));
return undef;
}
#####################################################
# reads obfuscated value
sub HTTPMOD_ReadKeyValue($$)
{
my ($hash, $kName) = @_;
my $name = $hash->{NAME};
my $index = $hash->{TYPE}."_".$hash->{NAME}."_".$kName;
my $key = getUniqueId().$index;
my ($value, $err);
Log3 $name, 5, "$name: ReadKeyValue tries to read value for $kName from file";
($err, $value) = getKeyValue($index);
if ( defined($err) ) {
Log3 $name, 4, "$name: ReadKeyValue is unable to read value from file: $err";
return undef;
}
if ( defined($value) ) {
if ( eval "use Digest::MD5;1" ) {
$key = Digest::MD5::md5_hex(unpack "H*", $key);
$key .= Digest::MD5::md5_hex($key);
}
my $dec = '';
for my $char (map { pack('C', hex($_)) } ($value =~ /(..)/g)) {
my $decode=chop($key);
$dec.=chr(ord($char)^ord($decode));
$key=$decode.$key;
}
return $dec;
}
else {
Log3 $name, 4, "$name: ReadKeyValue could not find key $kName in file";
return undef;
}
}
# replace strings as defined in Attributes for URL, Header and Data
# type is request type and can be set01, get03, auth01, update
#########################################################################
sub HTTPMOD_Replace($$$)
{
my ($hash, $type, $string) = @_;
my $name = $hash->{NAME};
my $context = "";
if ($type =~ /(auth|set|get)(.*)/) {
$context = $1; # context is type without num
# for type update there is no num so no individual replacement - only one for the whiole update request
}
#Log3 $name, 4, "$name: Replace called for request type $type";
# Loop through all Replacement Regex attributes
foreach my $rr (sort grep (/replacement[0-9]*Regex/, keys %{$attr{$name}})) {
$rr =~ /replacement([0-9]*)Regex/;
my $rNum = $1;
#Log3 $name, 5, "$name: Replace: rr=$rr, rNum $rNum, look for ${type}Replacement${rNum}Value";
my $regex = AttrVal($name, "replacement${rNum}Regex", "");
my $mode = AttrVal($name, "replacement${rNum}Mode", "text");
next if (!$regex);
my $value = "";
if ($context && defined ($attr{$name}{"${type}Replacement${rNum}Value"})) {
# get / set / auth mit individuellem Replacement für z.B. get01
$value = $attr{$name}{"${type}Replacement${rNum}Value"};
} elsif ($context && defined ($attr{$name}{"${context}Replacement${rNum}Value"})) {
# get / set / auth mit generischem Replacement für alle gets / sets
$value = $attr{$name}{"${context}Replacement${rNum}Value"};
} elsif (defined ($attr{$name}{"replacement${rNum}Value"})) {
# ganz generisches Replacement
$value = $attr{$name}{"replacement${rNum}Value"};
}
Log3 $name, 5, "$name: Replace called for type $type, regex $regex, mode $mode, " .
($value ? "value $value" : "empty value") . " input: $string";
my $match = 0;
if ($mode eq 'text') {
$match = ($string =~ s/$regex/$value/g);
} elsif ($mode eq 'reading') {
my $device = $name;
my $reading = $value;
if ($value =~ /^([^\:]+):(.+)$/) {
$device = $1;
$reading = $2;
}
my $rvalue = ReadingsVal($device, $reading, "");
if ($string =~ s/$regex/$rvalue/g) {
Log3 $name, 5, "$name: Replace: reading value is $rvalue";
$match = 1;
}
} elsif ($mode eq 'internal') {
my $device = $name;
my $internal = $value;
if ($value =~ /^([^\:]+):(.+)$/) {
$device = $1;
$internal = $2;
}
my $rvalue = InternalVal($device, $internal, "");
if ($string =~ s/$regex/$rvalue/g) {
Log3 $name, 5, "$name: Replace: internal value is $rvalue";
$match = 1;
}
} elsif ($mode eq 'expression') {
$match = eval {$string =~ s/$regex/$value/gee};
if ($@) {
Log3 $name, 3, "$name: Replace: invalid regex / expression: /$regex/$value/gee - $@";
}
} elsif ($mode eq 'key') {
my $rvalue = HTTPMOD_ReadKeyValue($hash, $value);
if ($string =~ s/$regex/$rvalue/g) {
Log3 $name, 5, "$name: Replace: key $value value is $rvalue";
$match = 1;
}
}
Log3 $name, 5, "$name: Replace: match and result is $string" if ($match);
}
return $string;
}
#
#########################################################################
sub HTTPMOD_ModifyWithExpr($$$$$)
{
my ($name, $context, $num, $attr, $text) = @_;
my $exp = AttrVal($name, "${context}${num}${attr}", undef);
if ($exp) {
my $old = $text;
$text = eval($exp);
if ($@) {
Log3 $name, 3, "$name: error in $attr for $context $num: $@";
}
Log3 $name, 5, "$name: $context $num used $attr to convert\n$old\nto\n$text\nusing expr $exp";
}
return $text;
}
#
#########################################################################
sub HTTPMOD_PrepareRequest($$;$)
{
my ($hash, $context, $num) = @_;
my $name = $hash->{NAME};
my ($url, $header, $data, $exp);
$num = 0 if (!$num); # num is not passed wehn called for update request
if ($context eq "reading") {
# called from GetUpdate - not Get / Set / Auth
$url = $hash->{MainURL};
$header = join ("\r\n", map ($attr{$name}{$_}, sort grep (/requestHeader/, keys %{$attr{$name}})));
$data = join ("\r\n", map ($attr{$name}{$_}, sort grep (/requestData/, keys %{$attr{$name}})));
} else {
# called for Get / Set / Auth
# hole alle Header bzw. generischen Header ohne Nummer
$header = join ("\r\n", map ($attr{$name}{$_}, sort grep (/${context}${num}Header/, keys %{$attr{$name}})));
if (length $header == 0) {
$header = join ("\r\n", map ($attr{$name}{$_}, sort grep (/${context}Header/, keys %{$attr{$name}})));
}
if (! HTTPMOD_GetFAttr($name, $context, $num, "NoData")) {
# hole Bestandteile der Post data
$data = join ("\r\n", map ($attr{$name}{$_}, sort grep (/${context}${num}Data/, keys %{$attr{$name}})));
if (length $data == 0) {
$data = join ("\r\n", map ($attr{$name}{$_}, sort grep (/${context}Data/, keys %{$attr{$name}})));
}
}
# hole URL
$url = HTTPMOD_GetFAttr($name, $context, $num, "URL");
if (!$url) {
$url = $hash->{MainURL};
}
}
$header = HTTPMOD_ModifyWithExpr($name, $context, $num, "HdrExpr", $header);
$data = HTTPMOD_ModifyWithExpr($name, $context, $num, "DatExpr", $data);
$url = HTTPMOD_ModifyWithExpr($name, $context, $num, "URLExpr", $url);
if (AttrVal($name, "enableCookies", 0) && $hash->{HTTPCookies}) {
Log3 $name, 5, "$name: PrepareRequest is adding Cookies: " . $hash->{HTTPCookies};
$header .= "Cookie: " . $hash->{HTTPCookies};
}
return ($url, $header, $data);
}
# create a new authenticated session
#########################################################################
sub HTTPMOD_Auth($@)
{
my ( $hash, @a ) = @_;
my $name = $hash->{NAME};
my ($url, $header, $data);
# get all steps
my %steps;
foreach my $attr (keys %{$attr{$name}}) {
if ($attr =~ /sid([0-9]+).+/) {
$steps{$1} = 1;
}
}
Log3 $name, 4, "$name: Auth called with Steps: " . join (" ", sort keys %steps);
$hash->{sid} = "" if AttrVal($name, "clearSIdBeforeAuth", 0);
foreach my $step (sort {$b cmp $a} keys %steps) { # reverse sort
($url, $header, $data) = HTTPMOD_PrepareRequest($hash, "sid", $step);
if ($url) {
# add to front of queue (prio)
HTTPMOD_AddToQueue($hash, $url, $header, $data, "auth$step", undef, 0, AttrVal($name, "sid${step}IgnoreRedirects", 0), 1);
} else {
Log3 $name, 3, "$name: no URL for Auth $step";
}
}
HTTPMOD_HandleSendQueue("direct:".$name); # AddToQueue with prio did not call this.
return undef;
}
# create hint list for set / get ?
########################################
sub HTTPMOD_UpdateHintList($)
{
my ($hash, $context) = @_;
my $name = $hash->{NAME};
Log3 $name, 5, "$name: UpdateHintList called";
$hash->{".getList"} = "";
if (AttrVal($name, "enableControlSet", undef)) { # spezielle Sets freigeschaltet?
#$hash->{".setList"} = "interval reread:noArg stop:noArg start:noArg ";
$hash->{".setList"} = "interval reread:noArg stop:noArg start:noArg upgradeAttributes:noArg storeKeyValue ";
} else {
$hash->{".setList"} = "";
}
foreach my $aName (grep /[gs]et[0-9]+Name/, keys %{$attr{$name}}) {
if ($aName =~ /([gs]et)([0-9]+)Name/) {
my $context = $1;
my $num = $2;
my $opt;
my $oName = $attr{$name}{$aName}; # value of the [gs]etXName attribute is name of the set/get option
if ($context eq "set") {
my $map = "";
$map = AttrVal($name, "${context}${num}Map", "") if ($context ne "get"); # old Map for set is now IMap (Input)
$map = AttrVal($name, "${context}${num}IMap", $map); # new syntax ovverides old one
if ($map) {
my $hint = $map; # create hint from map
$hint =~ s/([^,\$]+):([^,\$]+)(,?) */$2$3/g; # allow spaces in names
$hint =~ s/\s/ /g; # convert spaces for fhemweb
$opt = $oName . ":$hint"; # opt is Name:Hint (from Map)
} elsif (AttrVal($name, "${context}${num}NoArg", undef)) { # NoArg explicitely specified for a set?
$opt = $oName . ":noArg";
} else {
$opt = $oName; # nur den Namen für opt verwenden.
}
} elsif ($context eq "get") {
if (AttrVal($name, "${context}${num}TextArg", undef)) { # TextArg explicitely specified for a get?
$opt = $oName; # nur den Namen für opt verwenden.
} else {
$opt = $oName . ":noArg"; # sonst noArg bei get
}
}
if (AttrVal($name, "${context}${num}Hint", undef)) { # gibt es einen expliziten Hint?
$opt = $oName . ":" . AttrVal($name, "${context}${num}Hint", undef);
}
$hash->{".${context}List"} .= $opt . " "; # save new hint list
}
}
delete $hash->{".updateHintList"};
Log3 $name, 5, "$name: UpdateHintList: setlist = " . $hash->{".setList"};
Log3 $name, 5, "$name: UpdateHintList: getlist = " . $hash->{".getList"};
}
#
# SET command - handle predifined control sets
################################################
sub HTTPMOD_ControlSet($$$)
{
my ($hash, $setName, $setVal) = @_;
my $name = $hash->{NAME};
if ($setName eq 'interval') {
if (!$setVal) {
Log3 $name, 3, "$name: no interval (sec) specified in set, continuing with $hash->{Interval} (sec)";
return "No Interval specified";
} else {
if (int $setVal > 5) {
$hash->{Interval} = $setVal;
my $nextTrigger = gettimeofday() + $hash->{Interval};
RemoveInternalTimer("update:$name");
$hash->{TRIGGERTIME} = $nextTrigger;
$hash->{TRIGGERTIME_FMT} = FmtDateTime($nextTrigger);
InternalTimer($nextTrigger, "HTTPMOD_GetUpdate", "update:$name", 0);
Log3 $name, 3, "$name: timer interval changed to $hash->{Interval} seconds";
return "0";
} elsif (int $setVal <= 5) {
Log3 $name, 3, "$name: interval $setVal (sec) to small (must be >5), continuing with $hash->{Interval} (sec)";
return "interval too small";
}
}
} elsif ($setName eq 'reread') {
HTTPMOD_GetUpdate("reread:$name");
return "0";
} elsif ($setName eq 'stop') {
RemoveInternalTimer("update:$name");
$hash->{TRIGGERTIME} = 0;
$hash->{TRIGGERTIME_FMT} = "";
Log3 $name, 3, "$name: internal interval timer stopped";
return "0";
} elsif ($setName eq 'start') {
my $nextTrigger = gettimeofday() + $hash->{Interval};
$hash->{TRIGGERTIME} = $nextTrigger;
$hash->{TRIGGERTIME_FMT} = FmtDateTime($nextTrigger);
RemoveInternalTimer("update:$name");
InternalTimer($nextTrigger, "HTTPMOD_GetUpdate", "update:$name", 0);
Log3 $name, 5, "$name: internal interval timer set to call GetUpdate in " . int($hash->{Interval}). " seconds";
return "0";
} elsif ($setName eq 'upgradeAttributes') {
HTTPMOD_UpgradeAttributes($hash);
return "0";
} elsif ($setName eq 'storeKeyValue') {
my $key;
if ($setVal =~ /([^ ]+) +(.*)/) {
$key = $1;
my $err = HTTPMOD_StoreKeyValue($hash, $key, $2);
return $err if ($err);
} else {
return "Please give a key and a value to storeKeyValue";
}
return "0";
}
return undef; # no control set identified - continue with other sets
}
#
# SET command
#########################################################################
sub HTTPMOD_Set($@)
{
my ($hash, @a) = @_;
return "\"set HTTPMOD\" needs at least an argument" if (@a < 2);
# @a is an array with the command line: DeviceName, setName. Rest is setVal (splitted in fhem.pl by space and tab)
my ($name, $setName, @setValArr) = @a;
my $setVal = (@setValArr ? join(' ', @setValArr) : "");
my (%rmap, $setNum, $setOpt, $rawVal);
if (AttrVal($name, "disable", undef)) {
Log3 $name, 5, "$name: set called with $setName but device is disabled"
if ($setName ne "?");
return undef;
}
Log3 $name, 5, "$name: set called with $setName " . ($setVal ? $setVal : "")
if ($setName ne "?");
if (AttrVal($name, "enableControlSet", undef)) { # spezielle Sets freigeschaltet?
my $error = HTTPMOD_ControlSet($hash, $setName, $setVal);
return undef if (defined($error) && $error eq "0"); # control set found and done.
return $error if ($error); # error
# continue if function returned undef
}
# Vorbereitung:
# suche den übergebenen setName in den Attributen und setze setNum
foreach my $aName (keys %{$attr{$name}}) {
if ($aName =~ /set([0-9]+)Name/) { # ist das Attribut ein "setXName" ?
if ($setName eq $attr{$name}{$aName}) { # ist es der im konkreten Set verwendete setName?
$setNum = $1; # gefunden -> merke Nummer X im Attribut
}
}
}
# gültiger set Aufruf? ($setNum oben schon gesetzt?)
if(!defined ($setNum)) {
HTTPMOD_UpdateHintList($hash) if ($hash->{".updateHintList"});
return "Unknown argument $setName, choose one of " . $hash->{".setList"};
}
Log3 $name, 5, "$name: set found option $setName in attribute set${setNum}Name";
if (!AttrVal($name, "set${setNum}NoArg", undef)) { # soll überhaupt ein Wert übergeben werden?
if (!defined($setVal)) { # Ist ein Wert übergeben?
Log3 $name, 3, "$name: set without value given for $setName";
return "no value given to set $setName";
}
# Eingabevalidierung von Sets mit Definition per Attributen
# 1. Schritt, falls definiert, per Umkehrung der Map umwandeln (z.B. Text in numerische Codes)
my $map = AttrVal($name, "set${setNum}Map", ""); # old Map for set is now IMap (Input)
$map = AttrVal($name, "set${setNum}IMap", $map); # new syntax ovverides old one
if ($map) {
my $rm = $map;
$rm =~ s/([^, ][^,\$]*):([^,][^,\$]*),? */$2:$1, /g; # reverse map string erzeugen
$setVal = decode ('UTF-8', $setVal); # convert nbsp from fhemweb
$setVal =~ s/\s| / /g; # back to normal spaces
%rmap = split (/, *|:/, $rm); # reverse hash aus dem reverse string
if (defined($rmap{$setVal})) { # Eintrag für den übergebenen Wert in der Map?
$rawVal = $rmap{$setVal}; # entsprechender Raw-Wert für das Gerät
Log3 $name, 5, "$name: set found $setVal in rmap and converted to $rawVal";
} else {
Log3 $name, 3, "$name: set value $setVal did not match defined map";
return "set value $setVal did not match defined map";
}
} else {
# wenn keine map, dann wenigstens sicherstellen, dass Wert numerisch - falls nicht TextArg.
if (!AttrVal($name, "set${setNum}TextArg", undef)) {
if ($setVal !~ /^-?\d+\.?\d*$/) {
Log3 $name, 3, "$name: set - value $setVal is not numeric";
return "set value $setVal is not numeric";
}
}
$rawVal = $setVal;
}
# kein TextArg?
if (!AttrVal($name, "set${setNum}TextArg", undef)) {
# prüfe Min
if (AttrVal($name, "set${setNum}Min", undef)) {
my $min = AttrVal($name, "set${setNum}Min", undef);
Log3 $name, 5, "$name: is checking value $rawVal against min $min";
return "set value $rawVal is smaller than Min ($min)"
if ($rawVal < $min);
}
# Prüfe Max
if (AttrVal($name, "set${setNum}Max", undef)) {
my $max = AttrVal($name, "set${setNum}Max", undef);
Log3 $name, 5, "$name: set is checking value $rawVal against max $max";
return "set value $rawVal is bigger than Max ($max)"
if ($rawVal > $max);
}
}
# Konvertiere input mit IExpr falls definiert
my $exp = AttrVal($name, "set${setNum}Expr", ""); # old syntax for input in set
$exp = AttrVal($name, "set${setNum}IExpr", ""); # new syntax overrides old one
if ($exp) {
my $val = $rawVal;
$rawVal = eval($exp);
if ($@) {
Log3 $name, 3, "$name: Set error in setExpr $exp: $@";
} else {
Log3 $name, 5, "$name: set converted value $val to $rawVal using expr $exp";
}
}
Log3 $name, 4, "$name: set will now set $setName -> $rawVal";
} else {
# NoArg
$rawVal = 0;
Log3 $name, 4, "$name: set will now set $setName";
}
my ($url, $header, $data) = HTTPMOD_PrepareRequest($hash, "set", $setNum);
if ($url) {
HTTPMOD_AddToQueue($hash, $url, $header, $data, "set$setNum", $rawVal);
} else {
Log3 $name, 3, "$name: no URL for set $setNum";
}
return undef;
}
#
# GET command
#########################################################################
sub HTTPMOD_Get($@)
{
my ($hash, @a) = @_;
return "\"get HTTPMOD\" needs at least an argument" if ( @a < 2 );
# @a is an array with DeviceName, getName, options
my ($name, $getName, @getValArr) = @a;
my $getVal = (@getValArr ? join(' ', @getValArr) : ""); # optional value after get name - might be used in HTTP request
my $getNum;
if (AttrVal($name, "disable", undef)) {
Log3 $name, 5, "$name: get called with $getName but device is disabled"
if ($getName ne "?");
return undef;
}
Log3 $name, 5, "$name: get called with $getName " if ($getName ne "?");
# Vorbereitung:
# suche den übergebenen getName in den Attributen, setze getNum falls gefunden
foreach my $aName (keys %{$attr{$name}}) {
if ($aName =~ /get([0-9]+)Name/) { # ist das Attribut ein "getXName" ?
if ($getName eq $attr{$name}{$aName}) { # ist es der im konkreten get verwendete getName?
$getNum = $1; # gefunden -> merke Nummer X im Attribut
}
}
}
# gültiger get Aufruf? ($getNum oben schon gesetzt?)
if(!defined ($getNum)) {
HTTPMOD_UpdateHintList($hash) if ($hash->{".updateHintList"});
return "Unknown argument $getName, choose one of " . $hash->{".getList"};
}
Log3 $name, 5, "$name: get found option $getName in attribute get${getNum}Name";
Log3 $name, 4, "$name: get will now request $getName" .
($getVal ? ", value = $getVal" : ", no optional value");
my ($url, $header, $data) = HTTPMOD_PrepareRequest($hash, "get", $getNum);
if ($url) {
HTTPMOD_AddToQueue($hash, $url, $header, $data, "get$getNum", $getVal);
} else {
Log3 $name, 3, "$name: no URL for Get $getNum";
}
return "$getName requested, watch readings";
}
#
# request new data from device
# calltype can be update and reread
###################################
sub HTTPMOD_GetUpdate($)
{
my ($calltype, $name) = split(':', $_[0]);
my $hash = $defs{$name};
my ($url, $header, $data, $count);
my $now = gettimeofday();
Log3 $name, 4, "$name: GetUpdate called ($calltype)";
if ($calltype eq "update" && $hash->{Interval}) {
RemoveInternalTimer ("update:$name");
my $nt = gettimeofday() + $hash->{Interval};
$hash->{TRIGGERTIME} = $nt;
$hash->{TRIGGERTIME_FMT} = FmtDateTime($nt);
InternalTimer($nt, "HTTPMOD_GetUpdate", "update:$name", 0);
Log3 $name, 5, "$name: internal interval timer set to call GetUpdate again in " . int($hash->{Interval}). " seconds";
}
if (AttrVal($name, "disable", undef)) {
Log3 $name, 5, "$name: GetUpdate called but device is disabled";
return undef;
}
if ($hash->{MainURL}) {
# queue main get request
($url, $header, $data) = HTTPMOD_PrepareRequest($hash, "reading"); # context "reading" is used for other attrs relevant for GetUpdate
if ($url) {
HTTPMOD_AddToQueue($hash, $url, $header, $data, "update"); # use request type "update"
} else {
Log3 $name, 3, "$name: GetUpdate: no Main URL specified";
}
}
# check if additional readings with individual URLs need to be requested
foreach my $poll (sort grep (/^get[0-9]+Poll$/, keys %{$attr{$name}})) {
$poll =~ /^get([0-9]+)Poll$/;
next if (!$1);
my $getNum = $1;
my $getName = AttrVal($name, "get".$getNum."Name", "");
if ($getName) {
Log3 $name, 5, "$name: GetUpdate checks if poll required for $getName ($getNum)";
my $lastPoll = 0;
$lastPoll = $hash->{lastpoll}{$getName}
if ($hash->{lastpoll} && $hash->{lastpoll}{$getName});
my $dueTime = $lastPoll + AttrVal($name, "get".$getNum."PollDelay", 0);
if ($now >= $dueTime) {
Log3 $name, 5, "$name: GetUpdate will request $getName";
$hash->{lastpoll}{$getName} = $now;
($url, $header, $data) = HTTPMOD_PrepareRequest($hash, "get", $getNum);
if ($url) {
HTTPMOD_AddToQueue($hash, $url, $header, $data, "get$getNum");
} else {
Log3 $name, 3, "$name: no URL for Get $getNum";
}
} else {
Log3 $name, 5, "$name: GetUpdate will skip $getName, delay not over";
}
} else {
Log3 $name, 3, "$name: GetUpdate found $poll without a matching Name attribute - ignoring it";
}
}
}
# Try to call a parse function if defined
#########################################
sub HTTPMOD_TryCall($$$$)
{
my ($hash, $buffer, $fName, $type) = @_;
my $name = $hash->{NAME};
if (AttrVal($name, $fName, undef)) {
Log3 $name, 5, "$name: Read is calling $fName for HTTP Response to $type";
my $func = AttrVal($name, 'parseFunction1', undef);
no strict "refs";
eval { &{$func}($hash,$buffer) };
if( $@ ) {
Log3 $name, 3, "$name: error calling $func: $@";
}
use strict "refs";
}
}
# recoursive main part for
# HTTPMOD_FlattenJSON($$)
###################################
sub HTTPMOD_JsonFlatter($$;$)
{
my ($hash,$ref,$prefix) = @_;
my $name = $hash->{NAME};
$prefix = "" if( !$prefix );
#Log3 $name, 5, "$name: JSON Flatter with prefix $prefix, ref $ref, pointer to " . ref($ref);
if (ref($ref) eq "ARRAY" ) {
while( my ($key,$value) = each @{$ref}) {
#Log3 $name, 5, "$name: JSON Flatter recursive call in array while, key = $key, value = $value";
HTTPMOD_JsonFlatter($hash, $value, $prefix.sprintf("%02i",$key+1)."_");
}
} elsif (ref($ref) eq "HASH" ) {
while( my ($key,$value) = each %{$ref}) {
#Log3 $name, 5, "$name: JSON Flatter in hash while, key = $key, value = $value, ref(value) = " . ref($value);
if(ref($value) eq "HASH" or ref($value) eq "ARRAY") {
#Log3 $name, 5, "$name: JSON Flatter recursive call in hash while, key = $key, value = $value";
HTTPMOD_JsonFlatter($hash, $value, $prefix.$key."_");
} else {
if (defined ($value)) {
Log3 $name, 5, "$name: JSON Flatter sets $prefix$key to $value";
$hash->{ParserData}{JSON}{$prefix.$key} = $value;
}
}
}
}
}
# entry to create a flat hash
# out of a pares JSON hash hierarchy
####################################
sub HTTPMOD_FlattenJSON($$)
{
my ($hash, $buffer) = @_;
my $name = $hash->{NAME};
my $decoded = eval 'decode_json($buffer)';
if ($@) {
Log3 $name, 3, "$name: error while parsing JSON data: $@";
} else {
HTTPMOD_JsonFlatter($hash, $decoded);
Log3 $name, 5, "$name: extracted JSON values to internal";
}
}
# format a reading value
###################################
sub HTTPMOD_FormatReading($$$$)
{
my ($name, $context, $num, $val) = @_;
my ($format, $decode, $encode);
my $expr = "";
my $map = "";
if ($context eq "reading") {
$expr = AttrVal($name, 'readingsExpr' . $num, "") if ($context ne "set"); # very old syntax, not for set!
}
$decode = HTTPMOD_GetFAttr($name, $context, $num, "Decode");
$encode = HTTPMOD_GetFAttr($name, $context, $num, "Encode");
$map = HTTPMOD_GetFAttr($name, $context, $num, "Map") if ($context ne "set"); # not for set!
$map = HTTPMOD_GetFAttr($name, $context, $num, "OMap", $map); # new syntax
$format = HTTPMOD_GetFAttr($name, $context, $num, "Format");
$expr = HTTPMOD_GetFAttr($name, $context, $num, "Expr", $expr) if ($context ne "set"); # not for set!
$expr = HTTPMOD_GetFAttr($name, $context, $num, "OExpr", $expr); # new syntax
$val = decode($decode, $val) if ($decode);
$val = encode($encode, $val) if ($encode);
if ($expr) {
my $old = $val;
$val = eval $expr;
if ($@) {
Log3 $name, 3, "$name: FormatReading error, context $context, expression $expr: $@";
}
Log3 $name, 5, "$name: FormatReading changed value with Expr $expr from $old to $val";
}
if ($map) { # gibt es eine Map?
my %map = split (/, +|:/, $map); # hash aus dem map string
if (defined($map{$val})) { # Eintrag für den gelesenen Wert in der Map?
my $nVal = $map{$val}; # entsprechender sprechender Wert für den rohen Wert aus dem Gerät
Log3 $name, 5, "$name: FormatReading found $val in map and converted to $nVal";
$val = $nVal;
} else {
Log3 $name, 3, "$name: FormatReading could not match $val to defined map";
}
}
if ($format) {
Log3 $name, 5, "$name: FormatReading does sprintf with format " . $format .
" value is $val";
$val = sprintf($format, $val);
Log3 $name, 5, "$name: FormatReading sprintf result is $val";
}
return $val;
}
# extract reading for a buffer
###################################
sub HTTPMOD_ExtractReading($$$$)
{
my ($hash, $buffer, $context, $num) = @_;
my $name = $hash->{NAME};
my ($val, $reading, $regex) = ("", "", "");
my ($json, $xpath, $xpathst, $recomb, $regopt, $sublen);
my @subrlist = ();
my @matchlist = ();
my $try = 1; # was there any applicable parsing definition?
$json = HTTPMOD_GetFAttr($name, $context, $num, "JSON");
$xpath = HTTPMOD_GetFAttr($name, $context, $num, "XPath");
$xpathst = HTTPMOD_GetFAttr($name, $context, $num, "XPath-Strict");
$regopt = HTTPMOD_GetFAttr($name, $context, $num, "RegOpt");
$recomb = HTTPMOD_GetFAttr($name, $context, $num, "RecombineExpr");
$sublen = HTTPMOD_GetFAttr($name, $context, $num, "AutoNumLen");
# support for old syntax
if ($context eq "reading") {
$reading = AttrVal($name, 'readingsName'.$num, ($json ? $json : "unnamed-$num"));
$regex = AttrVal($name, 'readingsRegex'.$num, "");
}
# new syntax overrides reading and regex
$reading = HTTPMOD_GetFAttr($name, $context, $num, "Name", $reading);
$regex = HTTPMOD_GetFAttr($name, $context, $num, "Regex", $regex);
if ($regex) {
# old syntax for xpath and xpath-strict as prefix in regex - one result joined
if (AttrVal($name, "enableXPath", undef) && $regex =~ /^xpath:(.*)/) {
$xpath = $1;
Log3 $name, 5, "$name: ExtractReading $reading with old XPath syntax in regex /$regex/, xpath = $xpath";
eval {@matchlist = $hash->{ParserData}{XPathTree}->findnodes_as_strings($xpath)};
Log3 $name, 3, "$name: error in findvalues for XPathTree: $@" if ($@);
@matchlist = (join ",", @matchlist); # old syntax returns only one value
} elsif (AttrVal($name, "enableXPath-Strict", undef) && $regex =~ /^xpath-strict:(.*)/) {
$xpathst = $1;
Log3 $name, 5, "$name: ExtractReading $reading with old XPath-strict syntax in regex /$regex/...";
my $nodeset;
eval {$nodeset = $hash->{ParserData}{XPathStrictNodeset}->find($xpathst)};
if ($@) {
Log3 $name, 3, "$name: error in find for XPathStrictNodeset: $@";
} else {
foreach my $node ($nodeset->get_nodelist) {
push @matchlist, XML::XPath::XMLParser::as_string($node);
}
}
@matchlist = (join ",", @matchlist); # old syntax returns only one value
} else {
# normal regex
if ($regopt) {
Log3 $name, 5, "$name: ExtractReading $reading with regex /$regex/$regopt ...";
eval '@matchlist = ($buffer =~ /' . "$regex/$regopt" . ')';
Log3 $name, 3, "$name: error in regex matching with regex option: $@" if ($@);
} else {
Log3 $name, 5, "$name: ExtractReading $reading with regex /$regex/...";
@matchlist = ($buffer =~ /$regex/);
}
Log3 $name, 5, "$name: " . @matchlist . " capture group(s), matchlist = " . join ",", @matchlist if (@matchlist);
}
} elsif ($json) {
if (defined($hash->{ParserData}{JSON}) &&
defined($hash->{ParserData}{JSON}{$json})) {
@matchlist = ($hash->{ParserData}{JSON}{$json});
}
} elsif ($xpath) {
Log3 $name, 5, "$name: ExtractReading $reading with XPath $xpath";
eval {@matchlist = $hash->{ParserData}{XPathTree}->findnodes_as_strings($xpath)};
Log3 $name, 3, "$name: error in findvalues for XPathTree: $@" if ($@);
} elsif ($xpathst) {
Log3 $name, 5, "$name: ExtractReading $reading with XPath-Strict $xpathst";
my $nodeset;
eval {$nodeset = $hash->{ParserData}{XPathStrictNodeset}->find($xpathst)};
if ($@) {
Log3 $name, 3, "$name: error in find for XPathStrictNodeset: $@";
} else {
foreach my $node ($nodeset->get_nodelist) {
push @matchlist, XML::XPath::XMLParser::as_string($node);
}
}
} else {
$try = 0; # neither regex, xpath nor json attribute found ...
Log3 $name, 5, "$name: ExtractReading for context $context, num $num - no individual parse definition";
}
my $match = @matchlist;
if ($match) {
my ($eNum, $subReading);
my $group = 1;
my $subNum = "";
if ($recomb) {
Log3 $name, 5, "$name: ExtractReading is recombining $match matches with expression $recomb";
my $val = (eval $recomb);
if ($@) {
Log3 $name, 3, "$name: ExtractReading error in RecombineExpr: $@";
}
Log3 $name, 5, "$name: ExtractReading recombined matchlist to $val";
@matchlist = ($val);
$match = 1;
}
foreach $val (@matchlist) {
if ($match == 1) {
# only one match
$eNum = $num;
$subReading = $reading;
@subrlist = ($reading);
} else {
# multiple matches -> check for special name of readings
$eNum = $num ."-".$group;
# don't use GetFAttr here because we don't want to get the value of the generic attribute "Name"
# but this name with -group number added as default
if (defined ($attr{$name}{$context . $eNum . "Name"})) {
$subReading = $attr{$name}{$context . $eNum . "Name"};
} else {
if ($sublen) {
$subReading = "${reading}-" . sprintf ("%0${sublen}d", $group);
} else {
$subReading = "${reading}-$group";
}
$subNum = "-$group";
}
push @subrlist, $subReading;
}
$val = HTTPMOD_FormatReading($name, $context, $eNum, $val);
Log3 $name, 5, "$name: ExtractReading for match $group sets $subReading to $val";
readingsBulkUpdate( $hash, $subReading, $val );
$hash->{defptr}{readingBase}{$subReading} = $context;
$hash->{defptr}{readingNum}{$subReading} = $num;
$hash->{defptr}{readingSubNum}{$subReading} = $subNum;
delete $hash->{defptr}{readingOutdated}{$subReading};
$group++;
}
} else {
Log3 $name, 5, "$name: ExtractReading $reading did not match" if ($try);
}
return ($try, $match, $reading, @subrlist);
}
# pull log lines to a file
###################################
sub HTTPMOD_PullToFile($$$$)
{
my ($hash, $buffer, $num, $file) = @_;
my $name = $hash->{NAME};
my $reading = HTTPMOD_GetFAttr($name, "get", $num, "Name");
my $regex = HTTPMOD_GetFAttr($name, "get", $num, "Regex");
my $iterate = HTTPMOD_GetFAttr($name, "get", $num, "PullIterate");
my $recombine = HTTPMOD_GetFAttr($name, "get", $num, "RecombineExpr");
$recombine = '$1' if not ($recombine);
my $matches = 0;
$hash->{GetSeq} = 0 if (!$hash->{GetSeq});
Log3 $name, 5, "$name: Read is pulling to file, sequence is $hash->{GetSeq}";
while ($buffer =~ /$regex/g) {
$matches++;
no warnings qw(uninitialized);
my $val = eval($recombine);
if ($@) {
Log3 $name, 3, "$name: PullToFile error in RecombineExpr $recombine: $@";
} else {
Log3 $name, 3, "$name: Read pulled line $val";
}
}
Log3 $name, 3, "$name: Read pulled $matches lines";
if ($matches) {
if ($iterate && $hash->{GetSeq} < $iterate) {
$hash->{GetSeq}++;
Log3 $name, 5, "$name: Read is iterating pull until $iterate, next is $hash->{GetSeq}";
my ($url, $header, $data) = HTTPMOD_PrepareRequest($hash, "get", $num);
HTTPMOD_AddToQueue($hash, $url, $header, $data, "get$num");
} else {
Log3 $name, 5, "$name: Read is done with pull after $hash->{GetSeq}.";
}
} else {
Log3 $name, 5, "$name: Read is done with pull, no more lines matched";
}
return (1, 1, $reading);
}
# check max age of all readings
###################################
sub HTTPMOD_DoMaxAge($)
{
my ($hash) = @_;
my $name = $hash->{NAME};
my ($base, $num, $sub, $max, $rep, $mode, $time, $now);
my $readings = $hash->{READINGS};
return if (!$readings);
$now = gettimeofday();
readingsBeginUpdate($hash);
foreach my $reading (sort keys %{$readings}) {
my $key = $reading; # in most cases the reading name can be looked up in the readingBase hash
Log3 $name, 5, "$name: MaxAge: check reading $reading";
if ($hash->{defptr}{readingOutdated}{$reading}) {
Log3 $name, 5, "$name: MaxAge: reading $reading was outdated before - skipping";
next;
}
# get base name of definig attribute like "reading" or "get"
$base = $hash->{defptr}{readingBase}{$reading};
if (!$base && $reading =~ /(.*)(-[0-9]+)$/) {
# reading name endet auf -Zahl und ist nicht selbst per attr Name definiert
# -> suche nach attr Name mit Wert ohne -Zahl
$key = $1;
$base = $hash->{defptr}{readingBase}{$key};
Log3 $name, 5, "$name: MaxAge: no defptr for this name - reading name seems automatically created with $2 from $key and not updated recently";
}
if (!$base) {
Log3 $name, 5, "$name: MaxAge: reading $reading doesn't come from a -Name attr -> skipping";
next;
}
$num = $hash->{defptr}{readingNum}{$key};
if ($hash->{defptr}{readingSubNum}{$key}) {
$sub = $hash->{defptr}{readingSubNum}{$key};
} else {
$sub = "";
}
Log3 $name, 5, "$name: MaxAge: reading definition comes from $base, $num" . ($sub ? ", $sub" : "");
$max = HTTPMOD_GetFAttr($name, $base, $num . $sub, "MaxAge");
if ($max) {
$rep = HTTPMOD_GetFAttr($name, $base, $num . $sub, "MaxAgeReplacement", "");
$mode = HTTPMOD_GetFAttr($name, $base, $num . $sub, "MaxAgeReplacementMode", "text");
$time = ReadingsTimestamp($name, $reading, 0);
Log3 $name, 5, "$name: MaxAge: max = $max, mode = $mode, rep = $rep";
if ($now - time_str2num($time) > $max) {
if ($mode eq "expression") {
Log3 $name, 5, "$name: MaxAge: reading $reading too old - using Perl expression as MaxAge replacement: $rep";
my $val = ReadingsVal($name, $reading, "");
$rep = eval($rep);
if($@) {
Log3 $name, 3, "$name: MaxAge: error in replacement expression $1: $@";
$rep = "error in replacement expression";
} else {
Log3 $name, 5, "$name: MaxAge: result is $rep";
}
readingsBulkUpdate($hash, $reading, $rep);
} elsif ($mode eq "text") {
Log3 $name, 5, "$name: MaxAge: reading $reading too old - using $rep instead";
readingsBulkUpdate($hash, $reading, $rep);
} elsif ($mode eq "delete") {
Log3 $name, 5, "$name: MaxAge: reading $reading too old - delete it";
delete($defs{$name}{READINGS}{$reading});
delete $hash->{defptr}{readingOutdated}{$reading};
}
$hash->{defptr}{readingOutdated}{$reading} = 1;
}
} else {
Log3 $name, 5, "$name: MaxAge: No MaxAge attr for $base, $num, $sub";
}
}
readingsEndUpdate($hash, 1);
}
#
# extract cookies from HTTP Response Header
# called from _Read
###########################################
sub HTTPMOD_GetCookies($$)
{
my ($hash, $header) = @_;
my $name = $hash->{NAME};
Log3 $name, 5, "$name: looking for Cookies in $header";
foreach my $cookie ($header =~ m/set-cookie: ?(.*)/gi) {
Log3 $name, 5, "$name: Set-Cookie: $cookie";
$cookie =~ /([^,; ]+)=([^,; ]+)[;, ]*(.*)/;
Log3 $name, 5, "$name: Cookie: $1 Wert $2 Rest $3";
$hash->{HTTPCookieHash}{$1}{Value} = $2;
$hash->{HTTPCookieHash}{$1}{Options} = ($3 ? $3 : "");
}
$hash->{HTTPCookies} = join ("; ", map ($_ . "=".$hash->{HTTPCookieHash}{$_}{Value},
sort keys %{$hash->{HTTPCookieHash}}));
}
# initialize Parsers
# called from _Read
###################################
sub HTTPMOD_InitParsers($$)
{
my ($hash, $body) = @_;
my $name = $hash->{NAME};
# initialize parsers
if ($hash->{JSONEnabled}) {
HTTPMOD_FlattenJSON($hash, $body);
}
if ($hash->{XPathEnabled} && $body) {
$hash->{ParserData}{XPathTree} = HTML::TreeBuilder::XPath->new;
eval {$hash->{ParserData}{XPathTree}->parse($body)};
Log3 $name, ($@ ? 3 : 5), "$name: InitParsers: XPath parsing " . ($@ ? "error: $@" : "done.");
}
if ($hash->{XPathStrictEnabled} && $body) {
eval {$hash->{ParserData}{XPathStrictNodeset} = XML::XPath->new(xml => $body)};
Log3 $name, ($@ ? 3 : 5), "$name: InitParsers: XPath-Strict parsing " . ($@ ? "error: $@" : "done.");
}
}
# cleanup Parsers
# called from _Read
###################################
sub HTTPMOD_CleanupParsers($)
{
my ($hash) = @_;
my $name = $hash->{NAME};
if ($hash->{XPathEnabled}) {
eval {$hash->{ParserData}{XPathTree}->delete()};
Log3 $name, 3, "$name: error deleting XPathTree: $@" if ($@);
}
if ($hash->{XPathStrictEnabled}) {
eval {$hash->{ParserData}{XPathStrictNodeset}->cleanup()};
Log3 $name, 3, "$name: error deleting XPathStrict nodeset: $@" if ($@);
}
delete $hash->{ParserData};
}
# Extract SID
# called from _Read
###################################
sub HTTPMOD_ExtractSid($$$$)
{
my ($hash, $buffer, $context, $num) = @_;
my $name = $hash->{NAME};
Log3 $name, 5, "$name: ExtractSid called, context $context, num $num";
my $regex = AttrVal($name, "idRegex", "");
my $json = AttrVal($name, "idJSON", "");
my $xpath = AttrVal($name, "idXPath", "");
my $xpathst = AttrVal($name, "idXPath-Strict", "");
$regex = HTTPMOD_GetFAttr($name, $context, $num, "IDRegex", $regex);
$regex = HTTPMOD_GetFAttr($name, $context, $num, "IdRegex", $regex);
$json = HTTPMOD_GetFAttr($name, $context, $num, "IdJSON", $json);
$xpath = HTTPMOD_GetFAttr($name, $context, $num, "IdXPath", $xpath);
$xpathst = HTTPMOD_GetFAttr($name, $context, $num, "IdXPath-Strict", $xpathst);
my @matchlist;
if ($json) {
Log3 $name, 5, "$name: Checking SID with JSON $json";
if (defined($hash->{ParserData}{JSON}) &&
defined($hash->{ParserData}{JSON}{$json})) {
@matchlist = ($hash->{ParserData}{JSON}{$json});
}
} elsif ($xpath) {
Log3 $name, 5, "$name: Checking SID with XPath $xpath";
eval {@matchlist = $hash->{ParserData}{XPathTree}->findnodes_as_strings($xpath)};
Log3 $name, 3, "$name: error in findvalues for XPathTree: $@" if ($@);
} elsif ($xpathst) {
Log3 $name, 5, "$name: Checking SID with XPath-Strict $xpathst";
my $nodeset;
eval {$nodeset = $hash->{ParserData}{XPathStrictNodeset}->find($xpathst)};
if ($@) {
Log3 $name, 3, "$name: error in find for XPathStrictNodeset: $@";
} else {
foreach my $node ($nodeset->get_nodelist) {
push @matchlist, XML::XPath::XMLParser::as_string($node);
}
}
}
if (@matchlist) {
$buffer = join (' ', @matchlist);
if ($regex) {
Log3 $name, 5, "$name: ExtractSis is replacing buffer to check with match: $buffer";
} else {
$hash->{sid} = $buffer;
Log3 $name, 5, "$name: ExtractSid set sid to $hash->{sid}";
return 1;
}
}
if ($regex) {
if ($buffer =~ $regex) {
$hash->{sid} = $1;
Log3 $name, 5, "$name: ExtractSid set sid to $hash->{sid}";
return 1;
} else {
Log3 $name, 5, "$name: ExtractSid could not match buffer to IdRegex $regex";
}
}
return 0;
}
# Check if Auth is necessary
# called from _Read
###################################
sub HTTPMOD_CheckAuth($$$$$)
{
my ($hash, $buffer, $request, $context, $num) = @_;
my $name = $hash->{NAME};
my $regex = AttrVal($name, "reAuthRegex", "");
my $json = AttrVal($name, "reAuthJSON", "");
my $xpath = AttrVal($name, "reAuthXPath", "");
my $xpathst = AttrVal($name, "reAuthXPath-Strict", "");
if ($context =~ /([gs])et/) {
$regex = HTTPMOD_GetFAttr($name, $context, $num, "ReAuthRegex", $regex);
$json = HTTPMOD_GetFAttr($name, $context, $num, "ReAuthJSON", $json);
$xpath = HTTPMOD_GetFAttr($name, $context, $num, "ReAuthXPath", $xpath);
$xpathst = HTTPMOD_GetFAttr($name, $context, $num, "ReAuthXPath-Strict", $xpathst);
}
my @matchlist;
if ($json) {
Log3 $name, 5, "$name: Checking Auth with JSON $json";
if (defined($hash->{ParserData}{JSON}) &&
defined($hash->{ParserData}{JSON}{$json})) {
@matchlist = ($hash->{ParserData}{JSON}{$json});
}
} elsif ($xpath) {
Log3 $name, 5, "$name: Checking Auth with XPath $xpath";
eval {@matchlist = $hash->{ParserData}{XPathTree}->findnodes_as_strings($xpath)};
Log3 $name, 3, "$name: error in findvalues for XPathTree: $@" if ($@);
} elsif ($xpathst) {
Log3 $name, 5, "$name: Checking Auth with XPath-Strict $xpathst";
my $nodeset;
eval {$nodeset = $hash->{ParserData}{XPathStrictNodeset}->find($xpathst)};
if ($@) {
Log3 $name, 3, "$name: error in find for XPathStrictNodeset: $@";
} else {
foreach my $node ($nodeset->get_nodelist) {
push @matchlist, XML::XPath::XMLParser::as_string($node);
}
}
}
if (@matchlist) {
if ($regex) {
$buffer = join (' ', @matchlist);
Log3 $name, 5, "$name: CheckAuth is replacing buffer to check with match: $buffer";
} else {
Log3 $name, 5, "$name: CheckAuth matched: $buffer";
return 1;
}
}
if ($regex) {
Log3 $name, 5, "$name: CheckAuth is checking buffer with ReAuthRegex $regex";
if ($buffer =~ $regex) {
Log3 $name, 4, "$name: CheckAuth decided new authentication required (ReAuthRegex matched: $regex)";
if ($request->{retryCount} < AttrVal($name, "authRetries", 1)) {
HTTPMOD_Auth $hash;
#$request->{retryCount}++; # better add one in the call to AddToQueue
HTTPMOD_AddToQueue ($hash, $request->{url}, $request->{header},
$request->{data}, $request->{type}, $request->{value}, $request->{retryCount}+1);
Log3 $name, 4, "$name: CheckAuth requeued request $request->{type} after auth, retryCount $request->{retryCount} ...";
return 1;
} else {
Log3 $name, 4, "$name: CheckAuth has no more retries left - did authentication fail?";
}
}
}
return 0;
}
# update List of Readings to parse
# during GetUpdate cycle
###################################
sub HTTPMOD_UpdateReadingList($)
{
my ($hash) = @_;
my $name = $hash->{NAME};
my %khash;
foreach my $a (sort (grep (/readings?[0-9]*/, keys %{$attr{$name}}))) {
if (($a =~ /readingsName(.*)/) && defined ($attr{$name}{'readingsName' . $1})) {
$khash{$1} = 1; # old syntax
} elsif ($a =~ /reading([0-9]+).*/) {
$khash{$1} = 1; # new syntax
}
}
my @list = sort keys %khash;
$hash->{".readingParseList"} = \@list;
Log3 $name, 5, "$name: UpdateReadingList created list of reading.* nums to parse during getUpdate as @list";
delete $hash->{".updateReadingList"};
}
#
# read / parse new data from device
# - callback for non blocking HTTP
###################################
sub HTTPMOD_Read($$$)
{
my ($hash, $err, $body) = @_;
my $name = $hash->{NAME};
my $request = $hash->{REQUEST};
my $header = ($hash->{httpheader} ? $hash->{httpheader} : "");
my $type = $request->{type};
my ($num, $context, $authQueued);
my @subrlist = ();
# set attribute prefix and num for parsing and formatting depending on request type
if ($type =~ /(set|get)(.*)/) {
$num = $2;
$context = $1;
} elsif ($type =~ /(auth)(.*)/) {
$num = $2;
$context = "sid";
} else {
# request type was update for GetUpdate cycle
$num = "";
$context = "reading"; # relevant attributes start with "reading..."
}
$hash->{BUSY} = 0;
my $ll = ($err ? 3 : 5); # Log Level - 3 if error
Log3 $name, $ll, "$name: Read callback: request type was $type" .
" retry $request->{retryCount}" .
($header ? ",\r\nHeader: $header" : ", no headers") .
($body ? ",\r\nBody: $body" : ", body empty") .
($err ? ", \r\nError: $err" : "no error");
my $buffer = ($header ? $header . "\r\n\r\n" . $body : $body); # so header can be used to match e.g. sid
if ($err) {
$buffer = $buffer . "\r\n\r\n" . $err; # so err can be used in reAuthRegex matching
readingsSingleUpdate ($hash, "LAST_ERROR", $err, 1)
if (AttrVal($name, "showError", undef))
}
HTTPMOD_UpdateReadingList($hash) if ($hash->{".updateReadingList"});
HTTPMOD_GetCookies($hash, $header) if (AttrVal($name, "enableCookies", 0));
HTTPMOD_InitParsers($hash, $body);
if ($context eq "sid") {
HTTPMOD_ExtractSid($hash, $buffer, $context, $num);
} else {
$authQueued = HTTPMOD_CheckAuth($hash, $body, $request, $context, $num);
}
if ($err || $authQueued ||
($context =~ "set|sid" && !HTTPMOD_GetFAttr($name, $context, $num, "ParseResponse"))) {
# don't continue parsing response but still check maxAge for all readings
HTTPMOD_DoMaxAge($hash) if ($hash->{MaxAgeEnabled});
#Log3 $name, 4, "$name: Read: no further parsing";
HTTPMOD_CleanupParsers($hash);
return undef;
}
my ($checkAll, $tried, $match, $reading);
my @unmatched = (); my @matched = ();
readingsBeginUpdate($hash);
if ($context =~ "get|set") {
my $file = HTTPMOD_GetFAttr($name, $context, $num, "PullToFile");
if ($file) {
($tried, $match, $reading) = HTTPMOD_PullToFile($hash, $buffer, $num, $file);
@subrlist = ($reading);
} else {
($tried, $match, $reading, @subrlist) = HTTPMOD_ExtractReading($hash, $buffer, $context, $num);
}
if ($tried) {
if($match) {
push @matched, @subrlist;
} else {
push @unmatched, $reading;
}
}
$checkAll = HTTPMOD_GetFAttr($name, $context, $num, 'CheckAllReadings', !$tried);
# if ExtractReading2 could not find any parsing instruction (e.g. regex) then check all Readings
} else {
$checkAll = 1;
}
if (AttrVal($name, "extractAllJSON", "") || HTTPMOD_GetFAttr($name, $context, $num, "ExtractAllJSON")) {
# create a reading for each JSON object and use formatting options if a correspondig reading name / formatting is defined
if (ref $hash->{ParserData}{JSON} eq "HASH") {
foreach my $object (keys %{$hash->{ParserData}{JSON}}) {
my $value = $hash->{ParserData}{JSON}{$object};
my $rname = $object;
my $rnum = 0;
#Log3 $name, 5, "$name: looking at JSON object $object, value $value";
# is there a defined reading with that JSON path? -> take name and formatting
foreach my $rx (sort grep (/^reading[0-9]+JSON$/, keys %{$attr{$name}})) {
if ($object eq AttrVal($name, $rx, "")) {
# Name und ggf. Formattierung angegeben, nutze sie.
$rx =~ /^reading([0-9]+)JSON$/;
$rnum = $1;
$rname = AttrVal($name, "reading${rnum}Name", "");
$value = HTTPMOD_FormatReading($name, "reading", $rnum, $value);
}
}
Log3 $name, 5, "$name: Read set JSON $object as reading $rname to value " . $value;
readingsBulkUpdate($hash, $object, $value);
push @matched, $rname;
# unmatched is not filled for "ExtractAllJSON"
delete $hash->{defptr}{readingOutdated}{$object};
}
} else {
Log3 $name, 3, "$name: no parsed JSON structure available";
}
} elsif ($checkAll && defined($hash->{".readingParseList"})) {
# check all defined readings and try to extract them
Log3 $name, 5, "$name: Read starts parsing response to $type with defined readings: " .
join (",", @{$hash->{".readingParseList"}});
foreach $num (@{$hash->{".readingParseList"}}) {
# try to parse readings defined in reading.* attributes
(undef, $match, $reading, @subrlist) = HTTPMOD_ExtractReading($hash, $buffer, 'reading', $num);
if($match) {
push @matched, @subrlist;
} else {
push @unmatched, $reading;
}
}
}
readingsBulkUpdate($hash, "MATCHED_READINGS", join ' ', @matched)
if (AttrVal($name, "showMatched", undef));
if (!@matched) {
Log3 $name, 3, "$name: Read response to $type didn't match any Reading";
} else {
Log3 $name, 4, "$name: Read response to $type matched Reading(s) " . join ' ', @matched;
Log3 $name, 4, "$name: Read response to $type did not match " . join ' ', @unmatched if (@unmatched);
}
HTTPMOD_TryCall($hash, $buffer, 'parseFunction1', $type);
readingsEndUpdate($hash, 1);
HTTPMOD_TryCall($hash, $buffer, 'parseFunction2', $type);
HTTPMOD_HandleSendQueue("direct:".$name);
HTTPMOD_CleanupParsers($hash);
# check maxAge for all readings
HTTPMOD_DoMaxAge($hash) if ($hash->{MaxAgeEnabled});
return undef;
}
#######################################
# Aufruf aus InternalTimer mit "queue:$name"
# oder direkt mit $direct:$name
sub
HTTPMOD_HandleSendQueue($)
{
my (undef,$name) = split(':', $_[0]);
my $hash = $defs{$name};
my $queue = $hash->{QUEUE};
my $qlen = ($hash->{QUEUE} ? scalar(@{$hash->{QUEUE}}) : 0);
Log3 $name, 5, "$name: HandleSendQueue called, qlen = $qlen";
RemoveInternalTimer ("queue:$name");
if(defined($queue) && @{$queue} > 0) {
my $queueDelay = AttrVal($name, "queueDelay", 1);
my $now = gettimeofday();
if (!$init_done) { # fhem not initialized, wait with IO
InternalTimer($now+$queueDelay, "HTTPMOD_HandleSendQueue", "queue:$name", 0);
Log3 $name, 3, "$name: HandleSendQueue - init not done, delay sending from queue";
return;
}
if ($hash->{BUSY}) { # still waiting for reply to last request
InternalTimer($now+$queueDelay, "HTTPMOD_HandleSendQueue", "queue:$name", 0);
Log3 $name, 5, "$name: HandleSendQueue - still waiting for reply to last request, delay sending from queue";
return;
}
$hash->{REQUEST} = $queue->[0];
if($hash->{REQUEST}{url} ne "") { # if something to send - check min delay and send
my $minSendDelay = AttrVal($hash->{NAME}, "minSendDelay", 0.2);
if ($hash->{LASTSEND} && $now < $hash->{LASTSEND} + $minSendDelay) {
InternalTimer($now+$queueDelay, "HTTPMOD_HandleSendQueue", "queue:$name", 0);
Log3 $name, 5, "$name: HandleSendQueue - minSendDelay not over, rescheduling";
return;
}
# set parameters for HttpUtils from request into hash
$hash->{BUSY} = 1; # HTTPMOD queue is busy until response is received
$hash->{LASTSEND} = $now; # remember when last sent
$hash->{redirects} = 0;
$hash->{callback} = \&HTTPMOD_Read;
$hash->{url} = $hash->{REQUEST}{url};
$hash->{header} = $hash->{REQUEST}{header};
$hash->{data} = $hash->{REQUEST}{data};
$hash->{value} = $hash->{REQUEST}{value};
$hash->{timeout} = AttrVal($name, "timeout", 2);
$hash->{ignoreredirects} = $hash->{REQUEST}{ignoreredirects};
$hash->{httpversion} = AttrVal($name, "httpVersion", "1.0");
my $sslArgList = AttrVal($name, "sslArgs", undef);
if ($sslArgList) {
Log3 $name, 5, "$name: sslArgs is set to $sslArgList";
my %sslArgs = split (',', $sslArgList);
Log3 $name, 5, "$name: sslArgs hash keys: " . join(",", keys %sslArgs);
Log3 $name, 5, "$name: sslArgs hash values: " . join(",", values %sslArgs);
$hash->{sslargs} = \%sslArgs;
}
if (AttrVal($name, "noShutdown", undef)) {
$hash->{noshutdown} = 1;
} else {
delete $hash->{noshutdown};
};
# do user defined replacements first
if ($hash->{ReplacementEnabled}) {
$hash->{header} = HTTPMOD_Replace($hash, $hash->{REQUEST}{type}, $hash->{header});
$hash->{data} = HTTPMOD_Replace($hash, $hash->{REQUEST}{type}, $hash->{data});
$hash->{url} = HTTPMOD_Replace($hash, $hash->{REQUEST}{type}, $hash->{url});
}
# then replace $val in header, data and URL with value from request (setVal) if it is still there
$hash->{header} =~ s/\$val/$hash->{value}/g;
$hash->{data} =~ s/\$val/$hash->{value}/g;
$hash->{url} =~ s/\$val/$hash->{value}/g;
# sid replacement is also done here - just before sending so changes in session while request was queued will be reflected
if ($hash->{sid}) {
$hash->{header} =~ s/\$sid/$hash->{sid}/g;
$hash->{data} =~ s/\$sid/$hash->{sid}/g;
$hash->{url} =~ s/\$sid/$hash->{sid}/g;
}
Log3 $name, 4, "$name: HandleSendQueue sends request type $hash->{REQUEST}{type} to " .
"URL $hash->{url}, " .
($hash->{data} ? "data $hash->{data}, " : "No Data, ") .
($hash->{header} ? "header $hash->{header}, " : "No Header, ") .
"timeout $hash->{timeout}";
shift(@{$queue}); # remove first element from queue
HttpUtils_NonblockingGet($hash);
} else {
shift(@{$queue}); # remove invalid first element from queue
}
if(@{$queue} > 0) { # more items in queue -> schedule next handle
InternalTimer($now+$queueDelay, "HTTPMOD_HandleSendQueue", "queue:$name", 0);
}
}
}
#####################################
sub
HTTPMOD_AddToQueue($$$$$;$$$$){
my ($hash, $url, $header, $data, $type, $value, $count, $ignoreredirects, $prio) = @_;
my $name = $hash->{NAME};
$value = 0 if (!$value);
$count = 0 if (!$count);
$ignoreredirects = 0 if (!$ignoreredirects);
my %request;
$request{url} = $url;
$request{header} = $header;
$request{data} = $data;
$request{type} = $type;
$request{value} = $value;
$request{retryCount} = $count;
$request{ignoreredirects} = $ignoreredirects;
my $qlen = ($hash->{QUEUE} ? scalar(@{$hash->{QUEUE}}) : 0);
Log3 $name, 5, "$name: AddToQueue called, initial send queue length : $qlen" . ($prio ? " prio" : "");
Log3 $name, 5, "$name: AddToQueue " . ($prio ? "prepends " : "adds ") .
"type $request{type} to " .
"URL $request{url}, " .
($request{data} ? "data $request{data}, " : "no data, ") .
($request{header} ? "header $request{header}, " : "no headers, ") .
"retry $count";
if(!$qlen) {
$hash->{QUEUE} = [ \%request ];
} else {
if ($qlen > AttrVal($name, "queueMax", 20)) {
Log3 $name, 3, "$name: AddToQueue - send queue too long ($qlen), dropping request ($type), BUSY = $hash->{BUSY}";
} else {
if ($prio) {
unshift (@{$hash->{QUEUE}}, \%request); # an den Anfang
} else {
push(@{$hash->{QUEUE}}, \%request); # ans Ende
}
}
}
HTTPMOD_HandleSendQueue("direct:".$name) if (!$prio); # if prio is set, wait until all steps are added to the front - Auth will call HandleSendQueue then.
}
1;
=pod
=begin html
HTTPMOD
This module provides a generic way to retrieve information from devices with an HTTP Interface and store them in Readings or send information to such devices.
It queries a given URL with Headers and data defined by attributes.
From the HTTP Response it extracts Readings named in attributes using Regexes, JSON or XPath also defined by attributes.
To send information to a device, set commands can be configured using attributes.
Prerequisites
-
This Module uses the non blocking HTTP function HttpUtils_NonblockingGet provided by FHEM's HttpUtils in a new Version published in December 2013.
If not already installed in your environment, please update FHEM or install it manually using appropriate commands from your environment.
Define
define <name> HTTPMOD <URL> <Interval>
The module connects to the given URL every Interval seconds, sends optional headers
and data and then parses the response.
URL can be "none" and Interval can be 0 if you prefer to only query data manually with a get command and not automatically in a defined interval.
Example:
define PM HTTPMOD http://MyPoolManager/cgi-bin/webgui.fcgi 60
Simple configuration of HTTP Devices
In a simple configuration you don't need to define get or set commands. One common HTTP request is automatically sent in the
interval specified in the define command and to the URL specified in the define command.
Optional HTTP headers can be specified as attr requestHeader1 to attr requestHeaderX,
optional POST data as attr requestData and then
pairs of attr readingXName and attr readingXRegex,
attr readingXXPath, attr readingXXPath-Strict or attr readingXJSON
to define how values are parsed from the HTTP response and in which readings they are stored.
(The old syntax attr readingsNameX and attr readingsRegexX is still supported
but it can go away in a future version of HTTPMOD so the new one with attr readingXName
and attr readingXRegex should be preferred.
Example for a PoolManager 5:
define PM HTTPMOD http://MyPoolManager/cgi-bin/webgui.fcgi 60
attr PM reading01Name PH
attr PM reading01Regex 34.4001.value":[ \t]+"([\d\.]+)"
attr PM reading02Name CL
attr PM reading02Regex 34.4008.value":[ \t]+"([\d\.]+)"
attr PM reading03Name3TEMP
attr PM reading03Regex 34.4033.value":[ \t]+"([\d\.]+)"
attr PM requestData {"get" :["34.4001.value" ,"34.4008.value" ,"34.4033.value", "14.16601.value", "14.16602.value"]}
attr PM requestHeader1 Content-Type: application/json
attr PM requestHeader2 Accept: */*
attr PM stateFormat {sprintf("%.1f Grad, PH %.1f, %.1f mg/l Chlor", ReadingsVal($name,"TEMP",0), ReadingsVal($name,"PH",0), ReadingsVal($name,"CL",0))}
The regular expressions used will take the value that matches a capture group. This is the part of the regular expression inside ().
In the above example "([\d\.]+)" refers to numerical digits or points between double quotation marks. Only the string consiting of digits and points
will match inside (). This piece is assigned to the reading.
You can also use regular expressions that have several capture groups which might be helpful when parsing tables. In this case an attribute like
reading02Regex something[ \t]+([\d\.]+)[ \t]+([\d\.]+)
could match two numbers. When you specify only one reading02Name like
the name Temp will be used with the extension -1 and -2 thus giving a reading Temp-1 for the first number and Temp-2 for the second.
You can also specify individual names for several readings that get parsed from one regular expression with several capture groups by
defining attributes
reading02-1Name
reading02-2Name
...
The usual way to define readings is however to have an individual regular expression with just one capture group per reading as shown in the above example.
formating and manipulating values / readings
Values that are parsed from an HTTP response can be further treated or formatted with the following attributes:
(reading|get)[0-9]*(-[0-9]+)?OExpr
(reading|get)[0-9]*(-[0-9]+)?OMap
(reading|get)[0-9]*(-[0-9]+)?Format
(reading|get)[0-9]*(-[0-9]+)?Decode
(reading|get)[0-9]*(-[0-9]+)?Encode
They can all be specified for an individual reading, for all readings in one match (e.g. if a regular expression has several capture groups)
or for all readings in a get command (defined by getXX) or for all readings in the main reading list (defined by readingXX):
will format the reading with the name specified by the attribute reading01Name to be numerical with one digit after the decimal point.
If the attribute reading01Regex is used and contains several capture groups then the format will be applied to all readings thet are parsed
by this regex unless these readings have their own format specified by reading01-1Format, reading01-2Format and so on.
Can be used in cases where a regular expression specified as reading1regex contains several capture groups or an xpath specified
as reading01XPath creates several readings.
In this case reading01-2Format specifies the format to be applied to the second match.
applies to all readings defined by a reading-Attribute that have no more specific format.
If you need to do some calculation on a raw value before it is used as a reading, you can define the attribute readingOExpr.
It defines a Perl expression that is used in an eval to compute the readings value. The raw value will be in the variable $val.
Example:
attr PM reading03OExpr $val * 10
Just like in the above example of the readingFormat attributes, readingOExpr and the other following attributes
can be applied on several levels.
To map a raw numerical value to a name, you can use the readingOMap attribute.
It defines a mapping from raw values read from the device to visible values like "0:mittig, 1:oberhalb, 2:unterhalb".
Example:
attr PM reading02-3OMap 0:kalt, 1:warm, 2:sehr warm
If the value read from a http response is 1, the above map will transalte it to the string warm and the reading value will be set to warm.
To convert character sets, the module can first decode a string read from the device and then encode it again. For example:
This applies to all readings defined for Get-Commands.
Configuration to define a set command and send data to a device
When a set option is defined by attributes, the module will use the value given to the set command
and translate it into an HTTP-Request that sends the value to the device.
HTTPMOD has a built in replacement that replaces $val in URLs, headers or Post data with the value passed in the set command.
This value is internally stored in the internal "value" ($hash->{value}) so it can also be used in a user defined replacement.
Extension to the above example for a PoolManager 5:
attr PM set01Name HeizungSoll
attr PM set01URL http://MyPoolManager/cgi-bin/webgui.fcgi?sid=$sid
attr PM set01Hint 6,10,20,30
attr PM set01Min 6
attr PM set01Max 30
attr PM setHeader1 Content-Type: application/json
attr PM set01Data {"set" :{"34.3118.value" :"$val" }}
This example defines a set option with the name HeizungSoll.
By issuing set PM HeizungSoll 10 in FHEM, the value 10 will be sent in the defined HTTP
Post to URL http://MyPoolManager/cgi-bin/webgui.fcgi and with Post Data as
{"set" :{"34.3118.value" :"10" }}
The optional attributes set01Min and set01Max define input validations that will be checked in the set function.
the optional attribute set01Hint will define the way the Fhemweb GUI shows the input. This might be a slider or a selection list for example.
The HTTP response to such a request will be ignored unless you specify the attribute setParseResponse
for all set commands or set01ParseResponse for the set command with number 01.
If the HTTP response to a set command is parsed then this is done like the parsing of responses to get commands and you can use the attributes ending e.g. on
Format, Encode, Decode, OMap and OExpr to manipulate / format the values read.
If a parameter to a set command is not numeric but should be passed on to the device as text, then you can specify the attribute setTextArg. For example:
If a set command should not require a parameter at all, then you can specify the attribute NoArg. For example:
attr PM set03Name On
attr PM set03NoArg
Configuration to define a get command
When a get option is defined by attributes, the module allows querying additional values from the device that require
individual HTTP-Requests or special parameters to be sent
Extension to the above example:
attr PM get01Name MyGetValue
attr PM get01URL http://MyPoolManager/cgi-bin/directory/webgui.fcgi?special=1?sid=$sid
attr PM getHeader1 Content-Type: application/json
attr PM get01Data {"get" :{"30.1234.value"}}
This example defines a get option with the name MyGetValue.
By issuing get PM MyGetValue in FHEM, the defined HTTP request is sent to the device.
The HTTP response is then parsed using the same readingXXName and readingXXRegex attributes as above so
additional pairs will probably be needed there for additional values.
If the new get parameter should also be queried regularly, you can define the following optional attributes:
attr PM get01Poll 1
attr PM get01PollDelay 300
The first attribute includes this reading in the automatic update cycle and the second defines an
alternative lower update frequency. When the interval defined initially in the define is over and the normal readings
are read from the device, the update function will check for additional get parameters that should be included
in the update cycle.
If a PollDelay is specified for a get parameter, the update function also checks if the time passed since it has last read this value
is more than the given PollDelay. If not, this reading is skipped and it will be rechecked in the next cycle when
interval is over again. So the effective PollDelay will always be a multiple of the interval specified in the initial define.
Please note that each defined get command that is included in the regular update cycle will create its own HTTP request. So if you want to extract several values from the same request, it is much more efficient to do this by defining readingXXName and readingXXRegex, XPath or JSON attributes and to specify an interval and a URL in the define of the HTTPMOD device.
Handling sessions and logging in
In simple cases logging in works with basic authentication. In the case HTTPMOD accepts a username and password as part of the URL
in the form http://User:Password@192.168.1.18/something
However basic auth is seldom used. If you need to fill in a username and password in a HTML form and the session is then managed by a session id,
here is how to configure this:
when sending data to an HTTP-Device in a set, HTTPMOD will replace any $sid in the URL, Headers and Post data
with the internal $hash->{sid}.
To authenticate towards the device and give this internal a value, you can use an optional multi step login procedure
defined by the following attributes:
- sid[0-9]*URL
- sid[0-9]*Data.*
- sid[0-9]*Header.*
- idRegex
- idJSON
- idXPath
- idXPath-Strict
- (get|set|sid)[0-9]*IdRegex
- (get|set|sid)[0-9]*IdJSON
- (get|set|sid)[0-9]*IdXPath
- (get|set|sid)[0-9]*IdXPath-Strict
Each step can have a URL, Headers and Post Data. To extract the actual session Id, you can use regular expressions, JSON or XPath just like for the parsing of readings but with the attributes (get|set|sid)[0-9]*IdRegex, (get|set|sid)[0-9]*IdJSON, (get|set|sid)[0-9]*IdXPath or (get|set|sid)[0-9]*IdXPath-Strict.
An extracted session Id will be stored in the internal $hash->{sid}.
HTTPMOD will create a sorted list of steps (the numbers between sid and URL / Data / Header)
and the loop through these steps and send the corresponding requests to the device.
For each step a $sid in a Header or Post Data will be replaced with the current content of $hash->{sid}.
Using this feature, HTTPMOD can perform a forms based authentication and send user name, password or other necessary data to the device and save the session id for further requests.
If for one step not all of the URL, Data or Header Attributes are set, then HTTPMOD tries to use a
sidURL, sidData.* or sidHeader.* Attribue (without the step number after sid).
This way parts that are the same for all steps don't need to be defined redundantly.
To determine when this login procedure is necessary, HTTPMOD will first try to send a request without
doing the login procedure. If the result contains an error that authentication is necessary, then a login is performed.
To detect such an error in the HTTP response, you can again use a regular expression, JSON or XPath, this time with the attributes
- reAuthRegex
- reAuthJSON
- reAuthXPath
- reAuthXPath-Strict
- [gs]et[0-9]*ReAuthRegex
- [gs]et[0-9]*ReAuthJSON
- [gs]et[0-9]*ReAuthXPath
- [gs]et[0-9]*ReAuthXPath-Strict
reAuthJSON or reAuthXPath typically only extract one piece of data from a response.
If the existance of the specified piece of data is sufficent to start a login procedure, then nothing more needs to be defined to detect this situation.
If however the indicator is a status code that contains different values depending on a successful request and a failed request if a new authentication is needed,
then you can combine things like reAuthJSON with reAuthRegex. In this case the regex is only matched to the data extracted by JSON (or XPath).
This way you can easily extract the status code using JSON parsing and then specify the code that means "authentication needed" as a regular expression.
Example for a multi step login procedure:
attr PM reAuthRegex /html/dummy_login.htm
attr PM sidURL http://192.168.70.90/cgi-bin/webgui.fcgi?sid=$sid
attr PM sidHeader1 Content-Type: application/json
attr PM sid1IdRegex wui.init\('([^']+)'
attr PM sid2Data {"set" :{"9.17401.user" :"fhem" ,"9.17401.pass" :"password" }}
attr PM sid3Data {"set" :{"35.5062.value" :"128" }}
attr PM sid4Data {"set" :{"42.8026.code" :"pincode" }}
In this case HTTPMOD detects that a login is necessary by looking for the pattern /html/dummy_login.htm in the HTTP response.
If it matches, it starts a login sequence. In the above example all steps request the same URL. In step 1 only the defined header
is sent in an HTTP get request. The response will contain a session id that is extraced with the regex wui.init\('([^']+)'.
In the next step this session id is sent in a post request to the same URL where tha post data contains a username and password.
The a third and a fourth request follow that set a value and a code. The result will be a valid and authorized session id that can be used in other requests where $sid is part of a URL, header or post data and will be replaced with the session id extracted above.
In the special case where a session id is set as a HTTP-Cookie (with the header Set-cookie: in the HTTP response) HTTPMOD offers an even simpler way. With the attribute enableCookies a very basic cookie handling mechanism is activated that stores all cookies that the server sends to the HTTPMOD device and puts them back as cookie headers in the following requests.
For such cases no sidIdRegex and no $sid in a user defined header is necessary.
Parsing JSON
If a webservice delivers data in JSON format, HTTPMOD can directly parse JSON which might be easier in this case than definig regular expressions.
The next example shows the data that can be requested from a Poolmanager with the following partial configuration:
define test2 HTTPMOD none 0
attr test2 get01Name Chlor
attr test2 getURL http://192.168.70.90/cgi-bin/webgui.fcgi
attr test2 getHeader1 Content-Type: application/json
attr test2 getHeader2 Accept: */*
attr test2 getData {"get" :["34.4008.value"]}
The data in the HTTP response looks like this:
{
"data": {
"34.4008.value": "0.25"
},
"status": {
"code": 0
},
"event": {
"type": 1,
"data": "48.30000.0"
}
}
the classic way to extract the value 0.25 into a reading with the name Chlor with a regex would have been
attr test2 get01Regex 34.4008.value":[ \t]+"([\d\.]+)"
with JSON you can write
attr test2 get01JSON data_34.4008.value
or if you don't care about the naming of your readings, you can simply extract all JSON data with
attr test2 extractAllJSON
which would apply to all data read from this device and create the following readings out of the HTTP response shown above:
data_34.4008.value 0.25
event_data 48.30000.0
event_type 1
status_code 0
or you can specify
attr test2 get01ExtractAllJSON
which would only apply to all data read as response to the get command defined as get01.
Parsing http / XML using xpath
Another alternative to regex parsing is the use of XPath to extract values from HTTP responses.
The following example shows how XML data can be parsed with XPath-Strict or HTML Data can be parsed with XPath.
Both work similar and the example uses XML Data parsed with the XPath-Strict option:
If The XML data in the HTTP response looks like this:
<root xmlns:foo="http://www.foo.org/" xmlns:bar="http://www.bar.org">
<actors>
<actor id="1">Peter X</actor>
<actor id="2">Charles Y</actor>
<actor id="3">John Doe</actor>
</actors>
</root>
with XPath you can write
attr htest reading01Name Actor
attr htest reading01XPath-Strict //actor[2]/text()
This will create a reading with the Name "Actor" and the value "Charles Y".
Since XPath specifications can define several values / matches, HTTPMOD can also interpret these and store them in
multiple readings:
attr htest reading01Name Actor
attr htest reading01XPath-Strict //actor/text()
will create the readings
Actor-1 Peter X
Actor-2 Charles Y
Actor-3 John Doe
Further replacements of URL, header or post data
sometimes it is helpful to dynamically change parts of a URL, HTTP header or post data depending on existing readings, internals or perl expressions at runtime.
HTTPMOD has two built in replacements: one for values passed to a set or get command and the other one for the session id.
Before a request is sent, the placeholder $val is replaced with the value that is passed in a set command or an optional value that can be passed in a get command (see getXTextArg). This value is internally stored in the internal "value" so it can also be used in a user defined replacement as explaind in this section.
The other built in replacement is for the session id. If a session id is extracted via a regex, JSON or XPath the it is stored in the internal "sid" and the placeholder $sid in a URL, header or post data is replaced by the content of thus internal.
User defined replacement can exted this functionality and this might be needed to pass further variables to a server, a current date or other things.
To support this HTTPMOD offers user defined replacements that are as well applied to a request before it is sent to the server.
A replacement can be defined with the attributes
"replacement[0-9]*Regex "
"replacement[0-9]*Mode "
"replacement[0-9]*Value "
"[gs]et[0-9]*Replacement[0-9]*Value "
A replacement always replaces a match of a regular expression.
The way the replacement value is defined can be specified with the replacement mode. If the mode is reading,
then the value is interpreted as the name of a reading of the same device or as device:reading to refer to another device.
If the mode is internal, then the value is interpreted as the name of an internal of the same device or as device:internal to refer to another device.
The mode text will use the value as a static text and the mode expression will evaluate the value as a perl expression to compute the replacement. Inside such a replacement expression it is possible to refer to capture groups of the replacement regex.
The mode key will use a value from a key / value pair that is stored in an obfuscated form in the file system with the set storeKeyValue command. This might be useful for storing passwords.
Example:
attr mydevice getData {"get" :["%%value%%.value"]}
attr mydevice replacement01Mode text
attr mydevice replacement01Regex %%value%%
attr mydevice get01Name Chlor
attr mydevice get01Replacement01Value 34.4008
attr mydevice get02Name Something
attr mydevice get02Replacement01Value 31.4024
attr mydevice get05Name profile
attr mydevice get05URL http://www.mydevice.local/getprofile?password=%%password%%
attr mydevice replacement02Mode key
attr mydevice replacement02Regex %%password%%
attr mydevice get05Replacement02Value password
defines that %%value%% will be replaced by a static text.
All Get commands will be HTTP post requests of a similar form. Only the %%value%% will be different from get to get.
The first get will set the reading named Chlor and for the request it will take the generic getData and replace %%value%% with 34.4008.
A second get will look the same except a different name and replacement value.
With the command set storeKeyValue password geheim you can store the password geheim in an obfuscated form in the file system. To use this password and send it in a request you can use the above replacement with mode key. The value password will then refer to the ofuscated string stored with the key password.
HTTPMOD has two built in replacements: One for session Ids and another one for the input value in a set command.
The placeholder $sid is always replaced with the internal $hash->{sid} which contains the session id after it is extracted from a previous HTTP response. If you don't like to use the placeholder $sid the you can define your own replacement for example like:
attr mydevice replacement01Mode internal
attr mydevice replacement01Regex %session%
attr mydevice replacement01Value sid
Now the internal $hash->{sid} will be used as a replacement for the placeholder %session%.
In the same way a value that is passed to a set-command can be put into a request with a user defined replacement. In this case the internal $hash->{value} will contain the value passed to the set command. It might even be a string containing several values that could be put into several different positions in a request by using user defined replacements.
The mode expression allows you to define your own replacement syntax:
attr mydevice replacement01Mode expression
attr mydevice replacement01Regex {{([^}]+)}}
attr mydevice replacement01Value ReadingsVal("mydevice", $1, "")
attr mydevice getData {"get" :["{{temp}}.value"]}
In this example any {{name}} in a URL, header or post data will be passed on to the perl function ReadingsVal
which uses the string between {{}} as second parameter. This way one defined replacement can be used for many different
readings.
replacing reading values when they have not been updated / the device did not respond
If a device does not respond then the values stored in readings will keep the same and only their timestamp shows that they are outdated.
If you want to modify reading values that have not been updated for a number of seconds, you can use the attributes
(reading|get)[0-9]*(-[0-9]+)?MaxAge
(reading|get)[0-9]*(-[0-9]+)?MaxAgeReplacementMode
(reading|get)[0-9]*(-[0-9]+)?MaxAgeReplacement
Every time the module tries to read from a device, it will also check if readings have not been updated
for longer than the MaxAge attributes allow. If readings are outdated, the MaxAgeReplacementMode defines how the affected
reading values should be replaced. MaxAgeReplacementMode can be text, expression or delete.
MaxAge specifies the number of seconds that a reading should remain untouched before it is replaced.
MaxAgeReplacement contains either a static text that is used as replacement value or a Perl expression that is evaluated to
give the replacement value. This can be used for example to replace a temperature that has not bee updated for more than 5 minutes
with the string "outdated - was 12":
attr PM readingMaxAge 300
attr PM readingMaxAgeReplacement "outdated - was " . $val
attr PM readingMaxAgeReplacementMode expression
The variable $val contains the value of the reading before it became outdated.
If the mode is delete then the reading will be deleted if it has not been updated for the defined time.
If you want to replace or delete a reading immediatley if a device doid not respond, simply set the maximum time to a number smaller than the update interval. Since the max age is checked after a HTTP request was either successful or it failed, the reading will always contain the read value or the replacement after a failed update.
Set-Commands
As defined by the attributes set.*Name
If you set the attribute enableControlSet to 1, the following additional built in set commands are available:
- interval
set new interval time in seconds and restart the timer
- reread
request the defined URL and try to parse it just like the automatic update would do it every Interval seconds
without modifying the running timer.
- stop
stop interval timer.
- start
restart interval timer to call GetUpdate after interval seconds
- upgradeAttributes
convert the attributes for this device from the old syntax to the new one.
atributes with the description "this attribute should not be used anymore" or similar will be translated to the new syntax, e.g. readingsName1 to reading01Name.
- storeKeyValue
stores a key value pair in an obfuscated form in the file system. Such values can then be used in replacements where
the mode is "key" e.g. to avoid storing passwords in the configuration in clear text
Get-Commands
as defined by the attributes get.*Name
Attributes
- do_not_notify
- readingFnAttributes
- reading[0-9]+Name
the name of a reading to extract with the corresponding readingRegex, readingJSON, readingXPath or readingXPath-Strict
Please note that the old syntax readingsName.* does not work with all features of HTTPMOD and should be avoided. It might go away in a future version of HTTPMOD.
- (get|set)[0-9]+Name
Name of a get or set command to be defined. If the HTTP response that is received after the command is parsed with an individual parse option then this name is also used as a reading name. Please note that no individual parsing needs to be defined for a get or set. If no regex, XPath or JSON is specified for the command, then HTTPMOD will try to parse the response using all the defined readingRegex, reading XPath or readingJSON attributes.
- (get|set|reading)[0-9]+Regex
If this attribute is specified, the Regex defined here is used to extract the value from the HTTP Response
and assign it to a Reading with the name defined in the (get|set|reading)[0-9]+Name attribute.
If this attribute is not specified for an individual Reading or get or set but without the numbers in the middle, e.g. as getRegex or readingRegex, then it applies to all the other readings / get / set commands where no specific Regex is defined.
The value to extract should be in a capture group / sub expression e.g. ([\d\.]+) in the above example.
Multiple capture groups will create multiple readings (see explanation above)
Using this attribute for a set command (setXXRegex) only makes sense if you want to parse the HTTP response to the HTTP request that the set command sent by defining the attribute setXXParseResponse.
Please note that the old syntax readingsRegex.* does not work with all features of HTTPMOD and should be avoided. It might go away in a future version of HTTPMOD.
If for get or set commands neither a generic Regex attribute without numbers nor a specific (get|set)[0-9]+Regex attribute is specified and also no XPath or JSON parsing specification is given for the get or set command, then HTTPMOD tries to use the parsing definitions for general readings defined in reading[0-9]+Name, reading[0-9]+Regex or XPath or JSON attributes and assigns the Readings that match here.
- (get|set|reading)[0-9]+RegOpt
Lets the user specify regular expression modifiers. For example if the same regular expression should be matched as often as possible in the HTTP response,
then you can specify RegOpt g which will case the matching to be done as /regex/g
The results will be trated the same way as multiple capture groups so the reading name will be extended with -number.
For other possible regular expression modifiers see http://perldoc.perl.org/perlre.html#Modifiers
- (get|set|reading)[0-9]+XPath
defines an xpath to one or more values when parsing HTML data (see examples above)
Using this attribute for a set command only makes sense if you want to parse the HTTP response to the HTTP request that the set command sent by defining the attribute setXXParseResponse.
- get|set|reading[0-9]+XPath-Strict
defines an xpath to one or more values when parsing XML data (see examples above)
Using this attribute for a set command only makes sense if you want to parse the HTTP response to the HTTP request that the set command sent by defining the attribute setXXParseResponse.
- (get|set|reading)[0-9]+AutoNumLen
In cases where a regular expression or an XPath results in multiple results and these results are stored in a common reading name with extension -number, then
you can modify the format of this number to have a fixed length with leading zeros. AutoNumLen 3 for example will lead to reading names ending with -001 -002 and so on.
- get|set|reading[0-9]+JSON
defines a path to the JSON object wanted by concatenating the object names. See the above example.
If you don't know the paths, then start by using extractAllJSON and the use the names of the readings as values for the JSON attribute.
Please don't forget to also specify a name for a reading, get or set.
Using this attribute for a set command only makes sense if you want to parse the HTTP response to the HTTP request that the set command sent by defining the attribute setXXParseResponse.
- (get|set|reading)[0-9]*RecombineExpr
defines an expression that is used in an eval to compute one reading value out of the list of matches.
This is supposed to be used for regexes or xpath specifications that produce multiple results if only one result that combines them is wanted. The list of matches will be in the variable @matchlist.
Using this attribute for a set command only makes sense if you want to parse the HTTP response to the HTTP request that the set command sent by defining the attribute setXXParseResponse.
- get[0-9]*CheckAllReadings
this attribute modifies the behavior of HTTPMOD when the HTTP Response of a get command is parsed.
If this attribute is set to 1, then additionally to the matching of get specific regexe (get[0-9]*Regex), XPath or JSON
also all the reading names and parse definitions defined in Reading[0-9]+Name and Reading[0-9]+Regex, XPath or JSON attributes are checked and if they match, the coresponding Readings are assigned as well.
This is automatically done if a get or set command is defined without its own parse attributes.
- (get|reading)[0-9]*OExpr
defines an optional expression that is used in an eval to compute / format a readings value after parsing an HTTP response
The raw value from the parsing will be in the variable $val.
If specified as readingOExpr then the attribute value is a default for all other readings that don't specify an explicit reading[0-9]*Expr.
Please note that the old syntax readingsExpr.* does not work with all features of HTTPMOD and should be avoided. It might go away in a future version of HTTPMOD.
- (get|reading)[0-9]*Expr
This is the old syntax for (get|reading)[0-9]*OExpr. It should be replaced by (get|reading)[0-9]*OExpr. The set command upgradeAttributes which becomes visible when the attribute enableControlSet is set to 1, can do this renaming automatically.
- (get|reading)[0-9]*OMap
Map that defines a mapping from raw value parsed to visible values like "0:mittig, 1:oberhalb, 2:unterhalb".
If specified as readingOMap then the attribute value is a default for all other readings that don't specify
an explicit reading[0-9]*Map.
The individual options in a map are separated by a komma and an optional space. Spaces are allowed to appear in a visible value however kommas are not possible.
- (get|reading)[0-9]*Map
This is the old syntax for (get|reading)[0-9]*OMap. It should be replaced by (get|reading)[0-9]*OMap. The set command upgradeAttributes which becomes visible when the attribute enableControlSet is set to 1, can do this renaming automatically.
- (get|set|reading)[0-9]*Format
Defines a format string that will be used in sprintf to format a reading value.
If specified without the numbers in the middle e.g. as readingFormat then the attribute value is a default for all other readings that don't specify an explicit reading[0-9]*Format.
Using this attribute for a set command only makes sense if you want to parse the HTTP response to the HTTP request that the set command sent by defining the attribute setXXParseResponse.
- (get|set|reading)[0-9]*Decode
defines an encoding to be used in a call to the perl function decode to convert the raw data string read from the device to a reading.
This can be used if the device delivers strings in an encoding like cp850 instead of utf8.
If your reading values contain Umlauts and they are shown as strange looking icons then you probably need to use this feature.
Using this attribute for a set command only makes sense if you want to parse the HTTP response to the HTTP request that the set command sent by defining the attribute setXXParseResponse.
- (get|set|reading)[0-9]*Encode
defines an encoding to be used in a call to the perl function encode to convert the raw data string read from the device to a reading.
This can be used if the device delivers strings in an encoding like cp850 and after decoding it you want to reencode it to e.g. utf8.
If your reading values contain Umlauts and they are shown as strange looking icons then you probably need to use this feature.
Using this attribute for a set command only makes sense if you want to parse the HTTP response to the HTTP request that the set command sent by defining the attribute setXXParseResponse.
- (get|set)[0-9]*URL
URL to be requested for the get or set command.
If this option is missing, the URL specified during define will be used.
- (get|set)[0-9]*Data
optional data to be sent to the device as POST data when the get oer set command is executed.
if this attribute is specified, an HTTP POST method will be sent instead of an HTTP GET
- (get|set)[0-9]*NoData
can be used to override a more generic attribute that specifies POST data for all get commands.
With NoData no data is sent and therefor the request will be an HTTP GET.
- (get|set)[0-9]*Header.*
optional HTTP Headers to be sent to the device when the get or set command is executed
- requestHeader.*
Define an optional additional HTTP Header to set in the HTTP request
- requestData
optional POST Data to be sent in the request. If not defined, it will be a GET request as defined in HttpUtils used by this module
- get[0-9]+Poll
if set to 1 the get is executed automatically during the normal update cycle (after the interval provided in the define command has elapsed)
- get[0-9]+PollDelay
if the value should not be read in each iteration (after the interval given to the define command), then a
minimum delay can be specified with this attribute. This has only an effect if the above Poll attribute has
also been set. Every time the update function is called, it checks if since this get has been read the last time, the defined delay has elapsed. If not, then it is skipped this time.
PollDelay can be specified as seconds or as x[0-9]+ which means a multiple of the interval in the define command.
- (get|set)[0-9]*TextArg
For a get command this defines that the command accepts a text value after the option name.
By default a get command doesn't accept optional values after the command name.
If TextArg is specified and a value is passed after the get name then this value can then be used in a request URL, header or data
as replacement for $val or in a user defined replacement that uses the internal "value" ($hash->{value}).
If used for a set command then it defines that the value to be set doesn't require any validation / conversion.
The raw value is passed on as text to the device. By default a set command expects a numerical value or a text value that is converted to a numeric value using a map.
- set[0-9]+Min
Minimum value for input validation.
- set[0-9]+Max
Maximum value for input validation.
- set[0-9]+IExpr
Perl Expression to compute the raw value to be sent to the device from the input value passed to the set.
- set[0-9]+Expr
This is the old syntax for (get|reading)[0-9]*IExpr. It should be replaced by (get|reading)[0-9]*IExpr. The set command upgradeAttributes which becomes visible when the attribute enableControlSet is set to 1, can do this renaming automatically.
- set[0-9]+IMap
Map that defines a mapping from raw to visible values like "0:mittig, 1:oberhalb, 2:unterhalb". This attribute atomatically creates a hint for FhemWEB so the user can choose one of the visible values and HTTPMOD sends the raw value to the device.
- set[0-9]+Map
This is the old syntax for (get|reading)[0-9]*IMap. It should be replaced by (get|reading)[0-9]*IMap. The set command upgradeAttributes which becomes visible when the attribute enableControlSet is set to 1, can do this renaming automatically.
- set[0-9]+Hint
Explicit hint for fhemWEB that will be returned when set ? is seen.
- set[0-9]*NoArg
Defines that this set option doesn't require arguments. It allows sets like "on" or "off" without further values.
- set[0-9]*ParseResponse
defines that the HTTP response to the set will be parsed as if it was the response to a get command.
- (get|set)[0-9]*URLExpr
Defines a Perl expression to specify the HTTP Headers for this request. This overwrites any other header specification and should be used carefully only if needed. The original Header is availabe as $old. Typically this feature is not needed and it might go away in future versions of HTTPMOD. Please use the "replacement" attributes if you want to pass additional variable data to a web service.
- (get|set)[0-9]*DatExpr
Defines a Perl expression to specify the HTTP Post data for this request. This overwrites any other post data specification and should be used carefully only if needed. The original Data is availabe as $old. Typically this feature is not needed and it might go away in future versions of HTTPMOD. Please use the "replacement" attributes if you want to pass additional variable data to a web service.
- (get|set)[0-9]*HdrExpr
Defines a Perl expression to specify the URL for this request. This overwrites any other URL specification and should be used carefully only if needed. The original URL is availabe as $old. Typically this feature is not needed and it might go away in future versions of HTTPMOD. Please use the "replacement" attributes if you want to pass additional variable data to a web service.
- set[0-9]*ReAuthRegex
Regex that will detect when a session has expired during a set operation and a new login needs to be performed.
It works like the global reAuthRegex but is used for set operations.
- reAuthRegex
regular Expression to match an error page indicating that a session has expired and a new authentication for read access needs to be done.
This attribute only makes sense if you need a forms based authentication for reading data and if you specify a multi step login procedure based on the sid.. attributes.
This attribute is used for all requests. For set operations you can however specify individual reAuthRegexes with the set[0-9]*ReAuthRegex attributes.
- sid[0-9]*URL
different URLs or one common URL to be used for each step of an optional login procedure.
- sid[0-9]*IdRegex
different Regexes per login procedure step or one common Regex for all steps to extract the session ID from the HTTP response
- sid[0-9]*Data.*
data part for each step to be sent as POST data to the corresponding URL
- sid[0-9]*Header.*
HTTP Headers to be sent to the URL for the corresponding step
- sid[0-9]*IgnoreRedirects
tell HttpUtils to not follow redirects for this authentication request
- clearSIdBeforeAuth
will set the session id to "" before doing the authentication steps
- authRetries
number of retries for authentication procedure - defaults to 1
- replacement[0-9]*Regex
Defines a replacement to be applied to an HTTP request header, data or URL before it is sent. This allows any part of the request to be modified based on a reading, an internal or an expression.
The regex defines which part of a header, data or URL should be replaced. The replacement is defined with the following attributes:
- replacement[0-9]*Mode
Defines how the replacement should be done and what replacementValue means. Valid options are text, reading, internal and expression.
- replacement[0-9]*Value
Defines the replacement. If the corresponding replacementMode is text, then value is a static text that is used as the replacement.
If replacementMode is reading then Value can be the name of a reading of this device or it can be a reading of a different device referred to by devicename:reading.
If replacementMode is internal the Value can be the name of an internal of this device or it can be an internal of a different device referred to by devicename:internal.
If replacementMode is expression the the Value is treated as a Perl expression that computes the replacement value. The expression can use $1, $2 and so on to refer to capture groups of the corresponding regex that is matched against the original URL, header or post data.
If replacementMode is key then the module will use a value from a key / value pair that is stored in an obfuscated form in the file system with the set storeKeyValue command. This might be useful for storing passwords.
- [gs]et[0-9]*Replacement[0-9]*Value
This attribute can be used to override the replacement value for a specific get or set.
- get|reading[0-9]*MaxAge
Defines how long a reading is valid before it is automatically overwritten with a replacement when the read function is called the next time.
- get|reading[0-9]*MaxAgeReplacement
specifies the replacement for MaxAge - either as a static text or as a perl expression.
- get|reading[0-9]*MaxAgeReplacementMode
specifies how the replacement is interpreted: can be text, expression and delete.
- httpVersion
defines the HTTP-Version to be sent to the server. This defaults to 1.0.
- sslVersion
defines the SSL Version for the negotiation with the server. The attribute is evaluated by HttpUtils. If it is not specified, HttpUtils assumes SSLv23:!SSLv3:!SSLv2
- sslArgs
defines a list that is converted to a key / value hash and gets passed to HttpUtils. To avoid certificate validation for broken servers you can for example specify
attr myDevice sslArgs SSL_verify_mode,SSL_VERIFY_NONE
- noShutdown
pass the noshutdown flag to HTTPUtils for webservers that need it (some embedded webservers only deliver empty pages otherwise)
- disable
stop doing automatic HTTP requests while this attribute is set to 1
- enableControlSet
enables the built in set commands interval, stop, start, reread, upgradeAttributes, storeKeyValue.
- enableCookies
enables the built cookie handling if set to 1. With cookie handling each HTTPMOD device will remember cookies that the server sets and send them back to the server in the following requests.
This simplifies session magamenet in cases where the server uses a session ID in a cookie. In such cases enabling Cookies should be sufficient and no sidRegex and no manual definition of a Cookie Header should be necessary.
- showMatched
if set to 1 then HTTPMOD will create a reading with the name MATCHED_READINGS
that contains the names of all readings that could be matched in the last request.
- showError
if set to 1 then HTTPMOD will create a reading and event with the Name LAST_ERROR
that contains the error message of the last error returned from HttpUtils.
- timeout
time in seconds to wait for an answer. Default value is 2
- queueDelay
HTTP Requests will be sent from a queue in order to avoid blocking when several Requests have to be sent in sequence. This attribute defines the delay between calls to the function that handles the send queue. It defaults to one second.
- queueMax
Defines the maximum size of the send queue. If it is reached then further HTTP Requests will be dropped and not be added to the queue
- minSendDelay
Defines the minimum time between two HTTP Requests.
- enableXPath
This attribute should no longer be used. Please specify an HTTP XPath in the dedicated attributes shown above.
- enableXPath-Strict
This attribute should no longer be used. Please specify an XML XPath in the dedicated attributes shown above.
- parseFunction1 and parseFunction2
These functions allow an experienced Perl / Fhem developer to plug in his own parsing functions.
Please look into the module source to see how it works and don't use them if you are not sure what you are doing.
- Remarks regarding the automatically created userattr entries
Fhemweb allows attributes to be edited by clicking on them. However this does not work for attributes that match to a wildcard attribute. To circumvent this restriction HTTPMOD automatically adds an entry for each instance of a defined wildcard attribute to the device userattr list. E.g. if you define a reading[0-9]Name attribute as reading01Name, HTTPMOD will add reading01Name to the device userattr list. These entries only have the purpose of making editing in Fhemweb easier.
Author's notes
- If you don't know which URLs, headers or POST data your web GUI uses, you might try a local proxy like BurpSuite to track requests and responses
=end html
=cut