FHEM/fhem-mirror
2
0
Fork 0
mirror of https://github.com/fhem/fhem-mirror.git synced 2025-04-25 22:09:21 +00:00
Code Issues Releases Wiki Activity

50_SSChatBot: use setCredentials from SMUtils

Browse Source 
git-svn-id: https://svn.fhem.de/fhem/trunk@22923 2b470e98-0d58-463d-a4d8-8e2adae1ed80
This commit is contained in:
nasseeder1 2020-10-05 20:34:44 +00:00
parent 6de44475b9
commit 0e05f7a6ec
1 changed files with 77 additions and 95 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

172
fhem/FHEM/50_SSChatBot.pm
View File

@ -48,6 +48,7 @@ use FHEM::SynoModules::SMUtils qw(
completeAPI completeAPI
showAPIinfo showAPIinfo
evaljson evaljson
setCredentials
getCredentials getCredentials
showStoredCredentials showStoredCredentials
setReadingErrorNone setReadingErrorNone
@ -133,6 +134,7 @@ BEGIN {
# Versions History intern # Versions History intern
my %vNotesIntern = ( my %vNotesIntern = (
"1.11.4" => "05.10.2020 use setCredentials from SMUtils ",
"1.11.3" => "04.10.2020 use showStoredCredentials from SMUtils ", "1.11.3" => "04.10.2020 use showStoredCredentials from SMUtils ",
"1.11.2" => "01.10.2020 move startFunctionDelayed, checkSendRetry to SMUtils ", "1.11.2" => "01.10.2020 move startFunctionDelayed, checkSendRetry to SMUtils ",
"1.11.1" => "28.09.2020 use evaljson from SMUtils ", "1.11.1" => "28.09.2020 use evaljson from SMUtils ",
@ -183,6 +185,9 @@ my %vHintsExt_de = (
); );
# Standardvariablen
my $queueStartFn = "FHEM::SSChatBot::getApiSites"; # Startfunktion zur Queue-Abarbeitung
my %hset = ( # Hash für Set-Funktion my %hset = ( # Hash für Set-Funktion
botToken => { fn => \&_setbotToken }, botToken => { fn => \&_setbotToken },
listSendqueue => { fn => \&listSendqueue }, listSendqueue => { fn => \&listSendqueue },
@ -340,7 +345,8 @@ return 0;
# Gerät zu löschen die mit dieser Gerätedefinition zu tun haben. # Gerät zu löschen die mit dieser Gerätedefinition zu tun haben.
################################################################# #################################################################
sub Delete { sub Delete {
my ($hash, $arg) = @_; my $hash = shift;
my $arg = shift;
my $name = $hash->{NAME}; my $name = $hash->{NAME};
my $index = $hash->{TYPE}."_".$hash->{NAME}."_botToken"; my $index = $hash->{TYPE}."_".$hash->{NAME}."_botToken";
@ -377,7 +383,7 @@ sub Attr {
readingsBeginUpdate($hash); readingsBeginUpdate($hash);
readingsBulkUpdate ($hash, "state", $val); readingsBulkUpdate ($hash, "state", $val);
readingsEndUpdate ($hash,1); readingsEndUpdate ($hash, 1);
} }
if ($cmd eq "set") { if ($cmd eq "set") {
@ -456,14 +462,14 @@ sub _setbotToken {
my $prop = $paref->{prop}; my $prop = $paref->{prop};
return qq{The command "$opt" needs an argument.} if (!$prop); return qq{The command "$opt" needs an argument.} if (!$prop);
my ($success) = setToken($hash, $prop, "botToken"); my ($success) = setCredentials($hash, "botToken", $prop);
if($success) { if($success) {
CommandGet(undef, "$name chatUserlist"); # Chatuser Liste abrufen CommandGet(undef, "$name chatUserlist"); # Chatuser Liste abrufen
return qq{botToken saved successfully}; return qq{Token saved successfully};
} }
else { else {
return qq{Error while saving botToken - see logfile for details}; return qq{Error while saving the Token - see logfile for details};
} }
return; return;
@ -551,6 +557,7 @@ sub _setasyncSendItem {
channel => "", channel => "",
attachment => $attachment attachment => $attachment
}; };
addSendqueue ($params); addSendqueue ($params);
} }
@ -577,7 +584,10 @@ sub _setrestartSendqueue {
my $ret = getApiSites($name); my $ret = getApiSites($name);
return $ret if($ret); if($ret) {
return $ret;
}
return qq{The SendQueue has been restarted.}; return qq{The SendQueue has been restarted.};
} }
@ -723,6 +733,7 @@ sub _getchatChannellist {
channel => "", channel => "",
attachment => "" attachment => ""
}; };
addSendqueue($params); addSendqueue($params);
getApiSites ($name); getApiSites ($name);
@ -852,15 +863,15 @@ sub addSendqueue {
} }
my $entry = { my $entry = {
'opmode' => $opmode, 'opmode' => $opmode,
'method' => $method, 'method' => $method,
'userid' => $userid, 'userid' => $userid,
'channel' => $channel, 'channel' => $channel,
'text' => $text, 'text' => $text,
'attachment' => $attachment, 'attachment' => $attachment,
'fileUrl' => $fileUrl, 'fileUrl' => $fileUrl,
'retryCount' => 0 'retryCount' => 0
}; };
addSendqueueEntry ($hash, $entry); # den Datensatz zur Sendqueue hinzufügen addSendqueueEntry ($hash, $entry); # den Datensatz zur Sendqueue hinzufügen
@ -957,13 +968,13 @@ return;
# Auswertung Abruf apisites # Auswertung Abruf apisites
#################################################################################### ####################################################################################
sub getApiSites_parse { sub getApiSites_parse {
my $param = shift; my $param = shift;
my $err = shift; my $err = shift;
my $myjson = shift; my $myjson = shift;
my $hash = $param->{hash}; my $hash = $param->{hash};
my $name = $hash->{NAME}; my $name = $hash->{NAME};
my $opmode = $hash->{OPMODE}; my $opmode = $hash->{OPMODE};
my ($error,$errorcode,$success); my ($error,$errorcode,$success);
@ -971,7 +982,7 @@ sub getApiSites_parse {
Log3($name, 2, "$name - ERROR message: $err"); Log3($name, 2, "$name - ERROR message: $err");
setReadingErrorState ($hash, $err); setReadingErrorState ($hash, $err);
checkSendRetry ($name,1,"FHEM::SSChatBot::getApiSites"); checkSendRetry ($name, 1, $queueStartFn);
return; return;
} }
@ -980,7 +991,7 @@ sub getApiSites_parse {
if (!$success) { if (!$success) {
Log3($name, 4, "$name - Data returned: ".$myjson); Log3($name, 4, "$name - Data returned: ".$myjson);
checkSendRetry ($name,1,"FHEM::SSChatBot::getApiSites"); checkSendRetry ($name, 1, $queueStartFn);
return; return;
} }
@ -1000,7 +1011,7 @@ sub getApiSites_parse {
setReadingErrorState ($hash, $error, $errorcode); setReadingErrorState ($hash, $error, $errorcode);
Log3($name, 2, "$name - ERROR - $error"); Log3($name, 2, "$name - ERROR - $error");
checkSendRetry ($name,1,"FHEM::SSChatBot::getApiSites"); checkSendRetry ($name, 1, $queueStartFn);
return; return;
} }
@ -1010,7 +1021,7 @@ sub getApiSites_parse {
if ($opmode eq "apiInfo") { # API Infos in Popup anzeigen if ($opmode eq "apiInfo") { # API Infos in Popup anzeigen
showAPIinfo ($hash, $hash->{HELPER}{API}); # übergibt Referenz zum instanziierten API-Hash) showAPIinfo ($hash, $hash->{HELPER}{API}); # übergibt Referenz zum instanziierten API-Hash)
checkSendRetry ($name,0,"FHEM::SSChatBot::getApiSites"); checkSendRetry ($name, 0, $queueStartFn);
return; return;
} }
} }
@ -1021,7 +1032,7 @@ sub getApiSites_parse {
setReadingErrorState ($hash, $error, $errorcode); setReadingErrorState ($hash, $error, $errorcode);
Log3($name, 2, "$name - ERROR - $error"); Log3($name, 2, "$name - ERROR - $error");
checkSendRetry ($name,1,"FHEM::SSChatBot::getApiSites"); checkSendRetry ($name, 1, $queueStartFn);
return; return;
} }
} }
@ -1053,7 +1064,7 @@ sub chatOp {
setReadingErrorState ($hash, $error, $errorcode); setReadingErrorState ($hash, $error, $errorcode);
Log3($name, 2, "$name - ERROR - $error"); Log3($name, 2, "$name - ERROR - $error");
checkSendRetry ($name,1,"FHEM::SSChatBot::getApiSites"); checkSendRetry ($name, 1, $queueStartFn);
return; return;
} }
@ -1101,13 +1112,13 @@ sub chatOp {
} }
$param = { $param = {
url => $url, url => $url,
timeout => $httptimeout, timeout => $httptimeout,
hash => $hash, hash => $hash,
method => "GET", method => "GET",
header => "Accept: application/json", header => "Accept: application/json",
callback => \&chatOp_parse callback => \&chatOp_parse
}; };
HttpUtils_NonblockingGet ($param); HttpUtils_NonblockingGet ($param);
@ -1137,16 +1148,17 @@ sub chatOp_parse {
$errorcode = "800" if($err =~ /:\smalformed\sor\sunsupported\sURL$/xs); $errorcode = "800" if($err =~ /:\smalformed\sor\sunsupported\sURL$/xs);
setReadingErrorState ($hash, $err, $errorcode); setReadingErrorState ($hash, $err, $errorcode);
checkSendRetry ($name,1,"FHEM::SSChatBot::getApiSites"); checkSendRetry ($name, 1, $queueStartFn);
return; return;
}
} elsif ($myjson ne "") { elsif ($myjson ne "") {
# wenn die Abfrage erfolgreich war ($data enthält die Ergebnisdaten des HTTP Aufrufes) # wenn die Abfrage erfolgreich war ($data enthält die Ergebnisdaten des HTTP Aufrufes)
# Evaluiere ob Daten im JSON-Format empfangen wurden # Evaluiere ob Daten im JSON-Format empfangen wurden
($success) = evaljson ($hash,$myjson); ($success) = evaljson ($hash,$myjson);
unless ($success) {
if(!$success) {
Log3 ($name, 4, "$name - Data returned: ".$myjson); Log3 ($name, 4, "$name - Data returned: ".$myjson);
checkSendRetry ($name,1,"FHEM::SSChatBot::getApiSites"); checkSendRetry ($name, 1, $queueStartFn);
return; return;
} }
@ -1157,13 +1169,13 @@ sub chatOp_parse {
$success = $data->{'success'}; $success = $data->{'success'};
if ($success) { if($success) {
if($hmodep{$opmode} && defined &{$hmodep{$opmode}{fn}}) { if($hmodep{$opmode} && defined &{$hmodep{$opmode}{fn}}) {
&{$hmodep{$opmode}{fn}} ($hash, $data); &{$hmodep{$opmode}{fn}} ($hash, $data);
} }
checkSendRetry ($name,0,"FHEM::SSChatBot::getApiSites"); checkSendRetry ($name, 0, $queueStartFn);
readingsBeginUpdate ($hash); readingsBeginUpdate ($hash);
readingsBulkUpdateIfChanged ($hash, "Errorcode", "none" ); readingsBulkUpdateIfChanged ($hash, "Errorcode", "none" );
@ -1184,7 +1196,7 @@ sub chatOp_parse {
setReadingErrorState ($hash, $error, $errorcode); setReadingErrorState ($hash, $error, $errorcode);
Log3($name, 2, "$name - ERROR - Operation $opmode was not successful. Errorcode: $errorcode - $error"); Log3($name, 2, "$name - ERROR - Operation $opmode was not successful. Errorcode: $errorcode - $error");
checkSendRetry ($name,1,"FHEM::SSChatBot::getApiSites"); checkSendRetry ($name, 1, $queueStartFn);
} }
undef $data; undef $data;
@ -1321,6 +1333,7 @@ sub _parseSendItem {
my $postid = ""; my $postid = "";
my $idx = $hash->{OPIDX}; my $idx = $hash->{OPIDX};
my $uid = $data{SSChatBot}{$name}{sendqueue}{entries}{$idx}{userid}; my $uid = $data{SSChatBot}{$name}{sendqueue}{entries}{$idx}{userid};
if($data->{data}{succ}{user_id_post_map}{$uid}) { if($data->{data}{succ}{user_id_post_map}{$uid}) {
$postid = $data->{data}{succ}{user_id_post_map}{$uid}; $postid = $data->{data}{succ}{user_id_post_map}{$uid};
} }
@ -1333,38 +1346,6 @@ sub _parseSendItem {
return; return;
} }
######################################################################################
# botToken speichern
######################################################################################
sub setToken {
my ($hash, $token, $ao) = @_;
my $name = $hash->{NAME};
my ($success, $credstr, $index, $retcode);
my (@key,$len,$i);
$credstr = encode_base64($token);
# Beginn Scramble-Routine
@key = qw(1 3 4 5 6 3 2 1 9);
$len = scalar @key;
$i = 0;
$credstr = join "", map { $i = ($i + 1) % $len; chr((ord($_) + $key[$i]) % 256) } split //x, $credstr; ## no critic 'Map blocks'
# End Scramble-Routine
$index = $hash->{TYPE}."_".$hash->{NAME}."_".$ao;
$retcode = setKeyValue($index, $credstr);
if ($retcode) {
Log3($name, 2, "$name - Error while saving Token - $retcode");
$success = 0;
}
else {
($success, $token) = getCredentials($hash,1,$ao); # Credentials nach Speicherung lesen und in RAM laden ($boot=1)
}
return $success;
}
############################################################################################# #############################################################################################
# FHEMWEB Extension hinzufügen # FHEMWEB Extension hinzufügen
############################################################################################# #############################################################################################
@ -1695,27 +1676,27 @@ sub __botCGIcheckPayload {
my $h = shift; my $h = shift;
my $name = $hash->{NAME}; my $name = $hash->{NAME};
my $pldata = $h->{payload}; my $pldata = $h->{payload};
my ($success) = evaljson($hash,$pldata); my ($success) = evaljson($hash,$pldata);
if (!$success) { if (!$success) {
Log3($name, 1, "$name - ERROR - invalid JSON data received:\n".Dumper $pldata); Log3($name, 1, "$name - ERROR - invalid JSON data received:\n".Dumper $pldata);
return ("text/plain; charset=utf-8", "invalid JSON data received"); return ("text/plain; charset=utf-8", "invalid JSON data received");
} }
my $data = decode_json ($pldata); my $data = decode_json ($pldata);
Log3($name, 5, "$name - interactive object data (JSON decoded):\n". Dumper $data); Log3($name, 5, "$name - interactive object data (JSON decoded):\n". Dumper $data);
$h->{token} = $data->{token}; $h->{token} = $data->{token};
$h->{post_id} = $data->{post_id}; $h->{post_id} = $data->{post_id};
$h->{user_id} = $data->{user}{user_id}; $h->{user_id} = $data->{user}{user_id};
$h->{username} = $data->{user}{username}; $h->{username} = $data->{user}{username};
$h->{callback_id} = $data->{callback_id}; $h->{callback_id} = $data->{callback_id};
$h->{actions} = "type: ".$data->{actions}[0]{type}.", ". $h->{actions} = "type: ".$data->{actions}[0]{type}.", ".
"name: ".$data->{actions}[0]{name}.", ". "name: ".$data->{actions}[0]{name}.", ".
"value: ".$data->{actions}[0]{value}.", ". "value: ".$data->{actions}[0]{value}.", ".
"text: ".$data->{actions}[0]{text}.", ". "text: ".$data->{actions}[0]{text}.", ".
"style: ".$data->{actions}[0]{style}; "style: ".$data->{actions}[0]{style};
return; return;
} }
@ -1771,6 +1752,7 @@ sub __botCGIdataInterprete {
channel => "", channel => "",
attachment => "" attachment => ""
}; };
addSendqueue ($params); addSendqueue ($params);
} }