Merge branch 'upstream/develop' into 1088-log_request_data

Author: noplanman

CHANGELOG.md

@@ -11,6 +11,7 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
 - Bot API 4.8 (Extra Poll and Dice features).
 - Allow custom MySQL port to be defined for tests.
 - New static method `Entity::escapeMarkdownV2` for MarkdownV2.
+- Remove bot token from debug http logs, this can be disabled by setting `TelegramLog::$remove_bot_token` parameter to `false`
 - `TelegramLog::$always_log_request_and_response` parameter to force output of the request and response data to the debug log, also for successful requests
 ### Changed
 - [:exclamation:][unreleased-bc-static-method-entityescapemarkdown] Made `Entity::escapeMarkdown` static, to not require an `Entity` object.

doc/01-utils.md

@@ -46,6 +46,13 @@ If you's like to always log the request and response data to the debug log, also
 \Longman\TelegramBot\TelegramLog::$always_log_request_and_response = true;
 ```
 
+### Hiding API token from the log
+By default, the API token is removed from the log, to prevent any mistaken leakage when posting logs online.
+This behaviour can be changed by setting the appropriate variable:
+``php
+\Longman\TelegramBot\TelegramLog::$remove_bot_token = false;
+```
+
 [PSR-3]: https://www.php-fig.org/psr/psr-3
 [PSR-3-providers]: https://packagist.org/providers/psr/log-implementation
 [Monolog]: https://github.com/Seldaek/monolog

src/TelegramLog.php

@@ -57,6 +57,13 @@ class TelegramLog
      */
     protected static $debug_log_temp_stream_handle;
 
+    /**
+     * Remove bot token from debug stream
+     *
+     * @var bool
+     */
+    public static $remove_bot_token = true;
+
     /**
      * Initialise logging.
      *
@@ -92,7 +99,13 @@ public static function endDebugLogTempStream($message = '%s')
     {
         if (is_resource(self::$debug_log_temp_stream_handle)) {
             rewind(self::$debug_log_temp_stream_handle);
-            self::debug(sprintf($message, stream_get_contents(self::$debug_log_temp_stream_handle)));
+            $stream_contents = stream_get_contents(self::$debug_log_temp_stream_handle);
+
+            if (self::$remove_bot_token) {
+                $stream_contents = preg_replace('/\/bot(\d+)\:[\w\-]+\//', '/botBOT_TOKEN_REMOVED/', $stream_contents);
+            }
+
+            self::debug(sprintf($message, $stream_contents));
             fclose(self::$debug_log_temp_stream_handle);
             self::$debug_log_temp_stream_handle = null;
         }