50_SSChatBot: support of loglevel in HttpUtils

git-svn-id: https://svn.fhem.de/fhem/trunk@27591 2b470e98-0d58-463d-a4d8-8e2adae1ed80

fhem/CHANGED

@@ -1,5 +1,6 @@
 # Add changes at the top of the list. Keep it in ASCII, and 80-char wide.
 # Do not insert empty lines here, update check depends on it.
+ - change:  50_SSChatBot: support of loglevel in HttpUtils
  - change:  75_AutomowerConnectDevice: last revision, declared deprecated
             will be removed soon, change definition to AutomowerConnect
             use different application key

fhem/FHEM/50_SSChatBot.pm

@@ -114,6 +114,7 @@ BEGIN {
           readingsBulkUpdateIfChanged 
           readingsEndUpdate         
           setKeyValue
+          toJSON
           urlDecode
           FW_wname          
         )
@@ -135,6 +136,7 @@ BEGIN {
 
 # Versions History intern
 my %vNotesIntern = (
+  "1.14.0" => "08.04.2023  prepared for new Setter deletePostId, loglevel for HttpUtils ",
   "1.13.0" => "14.01.2023  new attr spareHost, sparePort ",
   "1.12.1" => "28.11.2020  fix cannot send after received anything, fix greedy regex in _botCGIcheckData ",
   "1.12.0" => "23.11.2020  generate event CHAT_INITIALIZED when users are once loaded, Forum: https://forum.fhem.de/index.php/topic,105714.msg1103700.html#msg1103700 ".
@@ -199,10 +201,11 @@ my $queueStartFn = "FHEM::SSChatBot::getApiSites";
 my $enctourl     = { map { sprintf("\\x{%02x}", $_) => sprintf( "%%%02X", $_ ) } ( 0 ... 255 ) };    # Standard Hex Codes zu UrlEncode, z.B. \x{c2}\x{b6} -> %C2%B6 -> ¶
 
 my %hset = (                                                                # Hash für Set-Funktion
+    asyncSendItem    => { fn => \&_setasyncSendItem    },
     botToken         => { fn => \&_setbotToken         }, 
+    deletePostId     => { fn => \&_setDeletePostId     },
     listSendqueue    => { fn => \&listSendqueue        },   
     purgeSendqueue   => { fn => \&purgeSendqueue       },
-    asyncSendItem    => { fn => \&_setasyncSendItem    },
     restartSendqueue => { fn => \&_setrestartSendqueue },
 );
 
@@ -445,8 +448,9 @@ sub Set {
   else {
       $setlist = "Unknown argument $opt, choose one of ".
                  "botToken ".
+                 #"deletePostId ".
                  "listSendqueue:noArg ".
-                 ($idxlist?"purgeSendqueue:-all-,-permError-,$idxlist ":"purgeSendqueue:-all-,-permError- ").
+                 ($idxlist ? "purgeSendqueue:-all-,-permError-,$idxlist " : "purgeSendqueue:-all-,-permError- ").
                  "restartSendqueue ".
                  "asyncSendItem:textField-long "
                  ;
@@ -585,6 +589,59 @@ sub _setasyncSendItem {
 return;
 }
 
+######################################################################################################
+#                                          Setter deletePostId
+#  Sending Beispiel:
+#  post_id: XXXXXXXXXXXX
+#  real_delete: false
+#  api: SYNO.Chat.Post
+#  method: delete
+#  version: 8
+#
+######################################################################################################
+sub _setDeletePostId {                                                     
+  my $paref = shift;
+  my $hash  = $paref->{hash};
+  my $name  = $paref->{name};
+  my $aref  = $paref->{aref};
+  
+  delete $hash->{HELPER}{RESENDFORCE};                                                      # Option 'force' löschen (könnte durch restartSendqueue gesetzt sein)      
+  
+  if(!$hash->{HELPER}{USERFETCHED}) {
+      return qq{The registered Synology Chat users are unknown. Please retrieve them first with "get $name chatUserlist".};
+  }
+  
+  my $postid   = q{};
+  my $cmd      = join " ", map { my $p = $_; $p =~ s/\s//xg; $p; } @$aref;     ## no critic 'Map blocks'
+  my ($arr,$h) = parseParams($cmd);
+  
+  if($arr) {
+      my @t = @{$arr};
+      shift @t; shift @t;
+      $postid = join ' ', @t;
+  }
+  
+  if ($postid !~ /^[0-9]+$/) {
+      return qq{The Post Id is incorrect. It must consist only of digits.};
+  }
+  
+  # Eintrag zur SendQueue hinzufügen
+  # Werte: (name,opmode,method,postid)
+  my $params = { 
+      name       => $name,
+      opmode     => 'delPostId',
+      method     => 'delete',
+      userid     => 'dummy',                                                               # wird nicht gebraucht, aber von SMUtils/addSendqueue verlangt
+      postid     => $postid
+  };
+  
+  addSendqueue ($params);
+   
+  getApiSites($name);
+      
+return;
+}
+
 ################################################################
 #                      Setter restartSendqueue
 ################################################################
@@ -1030,15 +1087,19 @@ return chatOp ($name);
 #                                     Ausführung Operation
 #############################################################################################
 sub chatOp {  
-   my $name         = shift;
+   my $name        = shift;
-   my $hash         = $defs{$name};
+   my $hash        = $defs{$name};
-   my $inprot       = $hash->{INPROT};
+   my $inprot      = $hash->{INPROT};
-   my $inaddr       = $hash->{INADDR};
+   my $inaddr      = $hash->{INADDR};
-   my $inport       = $hash->{INPORT};
+   my $inport      = $hash->{INPORT};
-   my $external     = $hash->{HELPER}{API}{EXTERNAL}{NAME}; 
+   my $extapi      = $hash->{HELPER}{API}{EXTERNAL}{NAME}; 
-   my $externalpath = $hash->{HELPER}{API}{EXTERNAL}{PATH};
+   my $extapipath  = $hash->{HELPER}{API}{EXTERNAL}{PATH};
-   my $externalver  = $hash->{HELPER}{API}{EXTERNAL}{VER};
+   my $exapiver    = $hash->{HELPER}{API}{EXTERNAL}{VER};
-   my ($url,$httptimeout,$param,$error,$errorcode);
+   my $postapi     = $hash->{HELPER}{API}{POST}{NAME}; 
+   my $postapipath = $hash->{HELPER}{API}{POST}{PATH};
+   my $postapiver  = $hash->{HELPER}{API}{POST}{VER};
+   
+   my ($url,$param,$postid,$error,$errorcode);
    
    # Token abrufen
    my ($success, $token) = getCredentials($hash, 0, "botToken");
@@ -1062,23 +1123,21 @@ sub chatOp {
    my $text        = $data{SSChatBot}{$name}{sendqueue}{entries}{$idx}{text};
    my $attachment  = $data{SSChatBot}{$name}{sendqueue}{entries}{$idx}{attachment};
    my $fileUrl     = $data{SSChatBot}{$name}{sendqueue}{entries}{$idx}{fileUrl};
+   my $httptimeout = AttrVal ($name, "httptimeout", 20);
+   my $humethod    = 'GET';                                                                        # HttpUtils Methode Get/Post
    
    Log3($name, 4, "$name - start SendQueue entry index \"$idx\" ($hash->{OPMODE}) for operation."); 
-
-   $httptimeout   = AttrVal($name, "httptimeout", 20);
-   
    Log3($name, 5, "$name - HTTP-Call will be done with httptimeout: $httptimeout s");
 
    if ($opmode =~ /^chatUserlist$|^chatChannellist$/x) {
-      $url = "$inprot://$inaddr:$inport/webapi/$externalpath?api=$external&version=$externalver&method=$method&token=\"$token\"";
+      $url = "$inprot://$inaddr:$inport/webapi/$extapipath?api=$extapi&version=$exapiver&method=$method&token=\"$token\"";
    }
-   
+   elsif ($opmode eq 'sendItem') {
-   if ($opmode eq "sendItem") {
       # Form: payload={"text": "a fun image", "file_url": "http://imgur.com/xxxxx" "user_ids": [5]} 
       #       payload={"text": "First line of message to post in the channel" "user_ids": [5]}
       #       payload={"text": "Check this!! <https://www.synology.com|Click here> for details!" "user_ids": [5]}
       
-      $url  = "$inprot://$inaddr:$inport/webapi/$externalpath?api=$external&version=$externalver&method=$method&token=\"$token\"";
+      $url  = "$inprot://$inaddr:$inport/webapi/$extapipath?api=$extapi&version=$exapiver&method=$method&token=\"$token\"";
       $url .= "&payload={";
       $url .= "\"text\": \"$text\","          if($text);
       $url .= "\"file_url\": \"$fileUrl\","   if($fileUrl);
@@ -1086,26 +1145,56 @@ sub chatOp {
       $url .= "\"user_ids\": [$userid]"       if($userid);
       $url .= "}";
    }
+   elsif ($opmode eq 'delPostId') {
+       $method    = $data{SSChatBot}{$name}{sendqueue}{entries}{$idx}{method};
+       $postid    = $data{SSChatBot}{$name}{sendqueue}{entries}{$idx}{postid};
+       $humethod  = 'POST';
+       
+       $url       = "$inprot://$inaddr:$inport/webapi/$postapipath";
+       
+   }
+   else {
+       return;
+   }
 
    my $part = $url;
    
    if(AttrVal($name, "showTokenInLog", "0") == 1) {
-       Log3($name, 4, "$name - Call-Out: $url");
+       Log3 ($name, 4, "$name - Call-Out >$humethod<: $url");
    } 
    else {
        $part =~ s/$token/<secret>/x;
-       Log3($name, 4, "$name - Call-Out: $part");
+       Log3 ($name, 4, "$name - Call-Out >$humethod<: $part");
    }
    
    $param = {
        url      => $url,
        timeout  => $httptimeout,
        hash     => $hash,
-       method   => "GET",
+       method   => $humethod,
        header   => "Accept: application/json",
        callback => \&chatOp_parse
    };
    
+   if ($opmode eq 'delPostId') {             
+       $param->{data}{post_id}     = $postid;
+       $param->{data}{real_delete} = 'false';
+       $param->{data}{api}         = $postapi;
+       $param->{data}{method}      = $method;
+       $param->{data}{version}     = $postapiver;
+       
+       Log3 ($name, 4, "$name - POST data:\n".Dumper $param->{data});
+       
+       $param->{header} = { "Content-Type" => "application/x-www-form-urlencoded; charset=UTF-8",
+                            "X-SYNO-TOKEN" => "matqxr5d.zxVY",
+                            "Cookie"       => 'io=F0f-zmlbaFNRC9uAAAAR; stay_login=1; smid=pW89VtXv5-Fv4O9Q4nPnN5fMZsIOX6pnS5ZEph8rQFlAzEAK3rD8BkH-vVev7Fs8yQG7yqlOgicbu0RFHr2dRA; id=I5WTEdH4py4aK_pRuXDxwLmA24Gv4yjKNRF5XhBl5vgCLn6_6ag4_2Sw_rM0oxEnER_OW5UyiQ5h8HIOgYgkLI',
+                          },      
+   }
+   
+   if (AttrVal ($name, 'verbose', 3) >= 5) {
+       $param->{loglevel} = 2;
+   }
+   
    HttpUtils_NonblockingGet ($param);   
 
 return;
@@ -1169,12 +1258,11 @@ sub chatOp_parse {
            readingsBulkUpdate          ($hash, "state",     "active");                    
            readingsEndUpdate           ($hash,1);   
        } 
-       else {
+       else {                                                               # die API-Operation war fehlerhaft, Errorcode aus JSON ermitteln
-           # die API-Operation war fehlerhaft
-           # Errorcode aus JSON ermitteln
            $errorcode = $data->{'error'}->{'code'};
            $cherror   = $data->{'error'}->{'errors'};                       # vom Chat gelieferter Fehler
            $error     = expErrors($hash,$errorcode);                        # Fehlertext zum Errorcode ermitteln
+           
            if ($error =~ /not\sfound\sfor\serror\scode:/x) {
                $error .= " New error: ".($cherror // "");
            }