Skip to content

Latest commit

 

History

History
753 lines (692 loc) · 36.9 KB

CHANGELOG.md

File metadata and controls

753 lines (692 loc) · 36.9 KB
Raw

Changelog

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

Exclamation symbols (:exclamation:) note something of importance e.g. breaking changes. Click them to learn more.

Unreleased

Notes

Added

Changed

Deprecated

Removed

Fixed

Security

0.83.0 - 2024-05-25

Notes

Added

  • Bot API 7.0 (@noplanman, @TiiFuchs) (#1459)
  • Bot API 7.1 (@noplanman) (#1465)

Changed

  • ❗ Various fields have been pluralised from "user" to "users".

Deprecated

Removed

Fixed

Security

0.82.0 - 2023-10-26

Notes

Added

  • Bot API 6.8, 6.9 (@noplanman) (#1418, #1427)
  • Test against PHP 8.3 (@sergiy-petrov) (#1421)

Fixed

  • Missing thumbnail_url renaming.
  • Fix broken exception handling (@mlocati) (#1425)

0.81.0 - 2023-05-27

Notes

Added

  • Support dynamic Entity properties for newer PHP versions (@alesinicio, @TiiFuchs) (#1390)
  • Bot API 6.4, 6.5, 6.6, 6.7 (@noplanman) (#1389)

Removed

  • Keyboard validations (@noplanman) (#1395)

Fixed

  • Fixed a bug where new incoming updates are not correctly passed to the Command object after the first time when getUpdates is used. (@uspilot) (#1384)

0.80.0 - 2022-11-09

Notes

Added

  • Bot API 6.3 (@TiiFuchs) (#1371)

Changed

  • ❗ Commands can now contain underscores (FooBarCommand is handled by /foo_bar). (@mlocati) (#1365)

0.79.0 - 2022-09-04

Notes

Added

  • Bot API 6.2 (@OxMohsen) (#1350)

Removed

  • VoiceChatX entities, use VideoChatX entities instead.
  • all_members_are_administrators property from Message entity. Database column still exists, but may be removed in the future.
  • Request::getChatMembersCount(), use Request::getChatMemberCount() instead.
  • Request::kickChatMember(), use Request::banChatMember() instead.

0.78.0 - 2022-07-03

Notes

Added

  • Bot API 6.1 (@jyxjjj, @OxMohsen, @noplanman) (#1333, #1338, #1339)
  • New Update field helpers for Command class.

0.77.1 - 2022-04-24

Notes

Fixed

  • PHP8+ mixed type hint removed

0.77.0 - 2022-04-24

Notes

Added

  • Bot API 6.0 (@TiiFuchs) (#1318)

Deprecated

  • Telegram changed voice_chat_X to video_chat_X. VoiceChatX event classes are deprecated, use new VideoChatX event classes instead.

Fixed

  • Return correct data in Entity::jsonSerialize (@TiiFuchs)

0.76.1 - 2022-03-30

Notes

Fixed

  • Fix Entity serialising for Keyboards (@TiiFuchs) (#1304)

0.76.0 - 2022-03-20

Notes

Added

  • Bot API 5.6 (@TiiFuchs) (#1275)
  • Bot API 5.7 (@TiiFuchs) (#1284)
  • PSR3 (psr/log) version 2 and 3 compatible (@noplanman) (#1287)
  • Entity implements and uses JsonSerializable now (@TiiFuchs)
  • Test with PHP 8.1 on Travis CI (@osavchenko) (#1291)

Changed

  • Bugfix: Fixed condition in \Longman\TelegramBot\Entities\Chat::isGroupChat() that previously also counted super groups and channels. (@TiiFuchs)

0.75.0 - 2021-12-29

Notes

Added

  • Ability to directly set commands paths. (@wright-tw, @noplanman) (#1252)
  • Bot API 5.4. (@TiiFuchs, @noplanman) (#1266)
  • Bot API 5.5. (@TiiFuchs, @noplanman) (#1267)
  • The field message_auto_delete_time was added to the Chat Entity (@TiiFuchs) (#1265)

Removed

  • ❗ Removed deprecated ChatAction:: RECORD_AUDIO and UPLOAD_AUDIO. Use RECORD_VOICE and UPLOAD_VOICE instead. (@TiiFuchs) (#1267)

Fixed

  • PHP 8.1 deprecations. (@maxgorovenko) (#1260)

0.74.0 - 2021-06-26

Notes

Added

  • ❗ Bot API 5.3 (Personalized Commands, Keyboard Placeholders). (@TiiFuchs, @noplanman) (#1229, #1231)

0.73.1 - 2021-06-20

Notes

Fixed

  • Allow new optional parameters when setting and deleting webhook. (@TiiFuchs) (#1226)

0.73.0 - 2021-06-14

Notes

Added

  • Bot API 5.2 (Payments 2.0). (#1216)
  • Possibility to connect to MySQL DB with unix socket. (@Tynik) (#1220)

Changed

  • Telegram::runCommands returns array of ServerResponse objects of executed commands. (#1223)

Fixed

  • Regex for namespace extraction from custom command classes.
  • Nested and user-triggered Telegram::runCommands. (#1223)

0.72.0 - 2021-04-16

Notes

Added

  • Bot API 5.1 (ChatMember Update types, Improved Invite Links, Voice Chat). (@massadm, @noplanman) (#1199)
  • Method to allow adding command classes directly. (@alligator77, @noplanman) (#1207, #1209)

Deprecated

  • Telegram::handleGetUpdates method should be passed a $data array for parameters. (#1202)

Fixed

  • message.edit_date is now of type timestamp. (#1191)
  • Allow all update types by default when using getUpdates method. (#1202)

0.71.0 - 2021-03-05

Notes

Added

  • Define a custom Bot API server and file download URI. (#1168)

Changed

  • Improved error messages for empty input. (#1164)
  • Log update when processing it, not when fetching input. (#1164)

Fixed

  • getUpdates method wrongly sends only 1 Update when a limit of 0 is passed. (#1169)
  • Telegram::runCommands() now passes the correct message text to the commands. (#1181)
  • Request limiter accepts chat ID as integer and string. (#1182)
  • Calling Keyboard constructor without any parameters. (@hutattedonmyarm) (#1184)

0.70.1 - 2020-12-25

Notes

Added

  • Extra parameter for Request::sendMessage() to pass options and return all response objects for split messages. (#1163)

Fixed

  • Ensure download and upload path variables are defined. (#1162)

0.70.0 - 2020-12-21

Notes

Added

  • Bot API 5.0 (Big update!). (#1147)

Changed

  • Upgrade code to PHP 7.3. (#1136, #1158)
  • Speed up /clean query. (@dva-re) (#1139)
  • Various code prettifications. (@akalongman) (#1140, #1141, #1142, #1143)

Security

  • Minimum PHP 7.3, allow PHP 8.0. (#1136, #1158)

0.64.0 - 2020-10-04

Notes

Added

  • Support for Guzzle 7. (@KristobalJunta) (#1133)

Fixed

  • Correct SQL migration script for older versions of MySQL. (#1135)

0.63.1 - 2020-06-24

Notes

Fixed

  • Regex in getFileNamespace() that introduced a breaking bug in #1114. (@jacklul) (#1115)
  • Fixed runCommands() not working due to custom namespace feature. (@jacklul) (#1115, #1118)

0.63.0 - 2020-06-17

Notes

Added

  • New method setUpdateFilter($callback) used to filter processUpdate(Update $update) calls. If $callback returns false the update isn't processed and an empty falsey ServerResponse is returned. (@VRciF) (#1045)
  • Replaced 'generic' and 'genericmessage' strings with Telegram::GENERIC_COMMAND and Telegram::GENERIC_MESSAGE_COMMAND constants. (@1int) (#1074)
  • Bot API 4.8 (Extra Poll and Dice features). (#1082)
  • Allow custom MySQL port to be defined for tests. (#1090)
  • New static method Entity::escapeMarkdownV2 for MarkdownV2. (#1094)
  • Remove bot token from debug http logs, this can be disabled by setting TelegramLog::$remove_bot_token parameter to false. (@jacklul) (#1095)
  • TelegramLog::$always_log_request_and_response parameter to force output of the request and response data to the debug log, also for successful requests. (#1089)
  • Bot API 4.9 (New via_bot field). (#1112)

Changed

  • ❗ Made Entity::escapeMarkdown static, to not require an Entity object. (#1094)
  • Allow custom namespacing for commands. (@Jonybang) (#689)

Fixed

  • Primary key for poll_answer also requires the user_id. (#1087)
  • Small SQL foreign key fixes. (#1105)

0.62.0 - 2020-04-08

Notes

Added

  • Bot API 4.5 (Unique file IDs, MarkdownV2). (#1046)
  • Chain the exception thrown when getting commands from path. (#1030)
  • Support language_code in DB::selectChats() for filtering the chats selection. (#1058)
  • Bot API 4.6 (Polls 2.0). (#1066)
  • Bot API 4.7 (Dice, Sticker Sets, Bot Commands). (#1067)

Changed

  • Save notes an unescaped JSON, to allow easy DB reading and editing of values. (#1005)
  • Request::setClient() now accepts more flexible ClientInterface. (#1068)

Removed

  • Unnecessary instanceof checks for entities. (#1068)
  • Unused Request::$input variable. (#1068)

Fixed

  • Execution of /start command without any custom implementation.
  • Return animation type for GIF Message (which returns both animation and document). (#1044)
  • Change lowercase function to mb_strtolower from strtolower because of latin-extented characters. (#1051)
  • Extend Request::mediaInputHelper() to include thumb parameter. (#1059)
  • Various docblock annotations. (#1068)

0.61.1 - 2019-11-23

Notes

Added

  • Tests for schema update scripts, to ensure that updates work as expected. (#1025)

Fixed

  • Parameter inline_query_id in InlineQuery::answerInlineQuery. (#1021)
  • Corrected DB schema update 0.60.0-0.61.0. (#1025)

0.61.0 - 2019-11-02

Notes

Added

  • Code snippet in GenericmessageCommand to keep obsolete service message system commands working. (#999)
  • Static boolean property SystemCommand::$execute_deprecated (must be assigned before handling the request) to try and execute any deprecated system command. (#999)
  • Improved MySQL DB index for message table, making the cleanup much faster on bigger databases. (Thanks to @damianperez) (#1015)
  • /cleanup command now supports dry run which simply outputs all queries that would be run. (#1015)

Changed

  • Small readme and code fixes / simplifications. (#1001)
  • Upgrade PHPUnit to 8.x and PHPCS to 3.5. For tests now minimum PHP version is 7.2. (#1008)
  • Updated updates log importer (requires PHP7+). (#1009)

Removed

  • Service message system commands, which are now handled by GenericmessageCommand. (#999)
  • ❗ Monolog has been removed as built-in logging engine. (#1009)
  • Assets have been moved to a dedicated repository. (#1012)

Fixed

  • Boolean value for Polls gets saved correctly in MySQL DB. (#996)
  • Correctly use Request::answerInlineQuery in InlineQuery::answer. (#1001)
  • PSR-12 incompatibilities in the codebase. (#1008)
  • Improved and corrected /cleanup command. (#1015)

0.60.0 - 2019-08-16

Notes

Added

  • Bot API 4.4 (Animated stickers, ChatPermissions). (#990)

Changed

  • Allow passing native entity objects to requests. (#991)

Fixed

  • Non-existing commands now correctly execute GenericCommand again. (#993)

0.59.1 - 2019-07-18

Notes

  • 📒 View file changes
  • ❗ Deprecated logging method will be removed in the next version, update to PSR-3 now! (see #964 for more info)

Added

  • Issue labels set automatically via templates.

Changed

  • Logging only updates or only debug/errors is now possible. (#983)

Fixed

  • Don't output deprecation notices if no logging is enabled. (#983)
  • Respect custom HTTP Client initialisation, no matter when it is set. (#986)

0.59.0 - 2019-07-07

Notes

Changed

  • Touched up readme including header and badges. (#981)
  • Updated changelog to be more useful for external integrations like Tidelift and GitHub releases. (#981)

Removed

  • Abstract methods from InputMedia interface, as method annotations didn't work for propagation. (#978)

0.58.0 - 2019-06-26

Notes

Added

  • New funding and support details. (#971)
  • Custom issue templates. (#972)
  • Bot API 4.3 (Seamless Telegram Login, LoginUrl) (#957)
  • reply_markup field to Message entity. (#957)

Changed

  • Use PSR-12 for code style. (#966)
  • Some general housekeeping. (#972)
  • ❗ Return an empty array for Entity properties with no items, instead of null. (#969)
  • TelegramLog now adheres to PSR-3 LoggerInterface and allows custom logger implementations. (#964)

Deprecated

  • Old logging that uses Monolog still works but will be removed in the near future. Use TelegramLog::initialize($logger, $update_logger); from now on. (#964)
  • ❗ StartCommand is now a UserCommand (not SystemCommand any more). (#970)

Removed

  • Botan.io integration completely removed. (#968)

Fixed

  • forward_date is now correctly saved to the DB. (#967)
  • Broken StickerSet::getStickers() method. (#969)
  • Smaller code and docblock fixes. (#973)

Security

  • Security disclosure managed by Tidelift. (#971)
  • Don't allow a user to call system commands directly. (#970)

0.57.0 - 2019-06-01

Notes

Added

  • New logo! 🎉 (#954)
  • Bot API 4.2 (Polls). (#948)
  • getIsMember() method to ChatMember entity. (#948)
  • getForwardSenderName() method to Message entity. (#948)
  • forward_sender_name (and forgotten forward_signature) DB fields. (#948)
  • Added missing API fields to Entities and DB. (#885)
  • Created database tables for shipping_query and pre_checkout_query. (#885)

Fixed

  • Missing DB table name specifier in /cleanup command. (#947)

0.56.0 - 2019-04-15

Notes

  • 📒 View file changes ∙ [:page_with_curl: DB migration script][0.56.0-sql-migration]
  • ❕ This is a big update, so please review the changelog carefully!

Added

  • Helper for sending InputMedia objects using Request::sendMediaGroup() and Request::editMediaMessage() methods.
  • Allow passing absolute file path for InputFile fields, instead of Request::encodeFile($path). (#934)

Changed

  • All Message field types dynamically search for an existing Command class that can handle them. (#940)
  • Upgrade dependencies. (#945)

Deprecated

  • Botan.io service has been discontinued. (#925)
  • Most built-in System Commands will be handled by GenericmessageCommand by default in a future release and will require a custom implementation. (#940)

Fixed

  • Constraint errors in /cleanup command. (#930)
  • Return correct objects for requests. (#934)
  • PHPCS: static before visibility declaration. (#945)

0.55.1 - 2019-01-06

Notes

Added

  • Add missing Request::editMessageMedia() and CallbackQuery::getChatInstance() methods. (#916)

Fixed

  • Return correct message type. (#913)

0.55.0 - 2018-12-20

Notes

Added

  • Bot API 4.0 and 4.1 (Telegram Passport) (#870, #871)
  • Test PHP 7.3 with Travis. (#903)

Changed

  • ❗ Move Animation entity out of Games namespace.

Fixed

  • Added missing video_note to Message types.

0.54.1 - 2018-10-23

Notes

Fixed

  • sendToActiveChats now works correctly for any valid Request action. (#898)

0.54.0 - 2018-07-21

Notes

Added

  • ChatAction class to simplify chat action selection. (#859)
  • Telegram Games platform! (#732)
  • Ability to set custom MySQL port. (#860)
  • New InvalidBotTokenException exception. (#855)

Changed

  • ❗ Rename and ensure no redefinition of constants: BASE_PATH -> TB_BASE_PATH, BASE_COMMANDS_PATH -> TB_BASE_COMMANDS_PATH. (#813)
  • Improve readability of readme code snippets. (#861)

Fixed

  • Response from getStickerSet. (#838)

0.53.0 - 2018-04-01

Notes

Added

  • Implemented new changes for Bot API 3.6 (streamable InputMediaVideo, connected website). (#799)
  • Telegram::getLastUpdateId() method, returns ID of the last update that was processed. (#767)
  • Telegram::useGetUpdatesWithoutDatabase() method, enables Telegram::handleGetUpdates() to run without a database. (#767)

Changed

  • Updated Travis to use Trusty containers (for HHVM) and add PHP 7.2 to the tests. (#739)
  • Add debug log entry instead of throwing an exception for duplicate updates. (#765)
  • Telegram::handleGetUpdates() can now work without a database connection (not enabled by default). (#767)
  • Improved /sendtochannel and /sendtoall commands, using new message helpers. (#810)

Fixed

  • PHPCS fixes for updated CodeSniffer dependency. (#739)
  • Send messages correctly via /sendtochannel. (#803)

0.52.0 - 2018-01-07

Notes

Fixed

  • Entity relations and wrong types for payments. (#731)
  • Allow empty string for switch_inline_query and switch_inline_query_current_chat (InlineKeyboardButton). (#736)
  • Fix empty date entry for User and Chat entities, using the current timestamp instead. (#738)

0.51.0 - 2017-12-05

Notes

Added

  • Implemented new changes for Bot API 3.5 (InputMedia, MediaGroup). (#718)

0.50.0 - 2017-10-17

Notes

Added

  • Finish implementing payments, adding all missing type checks and docblock methods. (#647)
  • Implemented new changes for Bot API 3.4 (Live Locations). (#675)

Changed

  • ❗ Message::getCommand() returns null if not a command, instead of false. (#654)

Fixed

  • SQL update script for version 0.44.1-0.45.0.
  • Issues found by Scrutinizer (Type hints and return values). (#654)
  • Check inline keyboard button parameter value correctly. (#672)

0.49.0 - 2017-09-17

Notes

Added

  • Donation section and links in readme.
  • Missing payment methods in Request class.
  • Some helper methods for replying to commands and answering queries.

Changed

  • Updated and optimised all DB classes, removing a lot of bulky code.

Fixed

  • Ensure named SQL statement parameters are unique.
  • Channel selection when using DB::selectChats().

0.48.0 - 2017-08-26

Notes

Added

  • New entities, methods, update types and inline keyboard button for Payments (Bot API 3.0).
  • Add new methods, fields and objects for working with stickers (Bot API 3.2).
  • New fields for Chat, User and Message objects (Bot API 3.3). is_bot added to user DB table.

Changed

  • ❗ Corrected ServerResponse->printError method to print by default and return by setting $return parameter.
  • Ensure command names are handled as lower case.

Fixed

  • Correctly save reply_to_message to DB.

0.47.1 - 2017-08-06

Notes

Added

  • Linked version numbers in changelog for easy verification of code changes.

Fixed

  • Private-only commands work with edited messages now too.

0.47.0 - 2017-08-06 [YANKED]

Notes

Changed

  • Updated readme to latest state of 0.47.0.

Fixed

  • Telegram::enableAdmin() now handles duplicate additions properly.
  • Request::getMe() failure doesn't break cron execution any more.

Security

  • ❗ New command parameter $private_only to enforce usage in private chats only (set by default for Admin commands).

0.46.0 - 2017-07-15

Notes

Added

  • Callbacks can be added to be executed when callback queries are called.
  • New Bot API 3.1 changes (#550).
  • /cleanup command for admins, that cleans out old entries from the DB.

Changed

  • ❗ Big refactor of the Request class, removing most custom method implementations.

0.45.0 - 2017-06-25

Notes

Added

  • Documents can be sent by providing its contents via Psr7 stream (as opposed to passing a file path).
  • Allow setting a custom Guzzle HTTP Client for requests (#511, #536).
  • First implementations towards Bots API 3.0.

Changed

  • ❗ Request::sendToActiveChats and DB::selectChats now accept parameters as an options array and allow selecting of channels.

Deprecated

  • Deprecated Message::getNewChatMember() (Use Message::getNewChatMembers() instead to get an array of all newly added members).

Removed

  • ❗ Upload and download directories are not set any more by default and must be set manually.
  • ❗ Completely removed Telegram::getBotName() and Entity::getBotName() (Use ::getBotUsername() instead).
  • ❗ Completely removed deprecated Telegram::unsetWebhook() (Use Telegram::deleteWebhook() instead).

Fixed

  • ID fields are now typed with PARAM_STR PDO data type, to allow huge numbers.
  • Message type data type for PDO corrected.
  • Indexed table columns now have a fitting length.
  • Take custom_input into account when using getUpdates method (mainly for testing).
  • Request limiter has been fixed to correctly support channels.

0.44.1 - 2017-04-25

Notes

Fixed

  • Erroneous exception when using webhook without a database connection.

0.44.0 - 2017-04-25

Notes

Added

  • Proper standalone scrutinizer.yml config.
  • Human-readable last_error_date_string for debug command.

Changed

  • Bot username no longer required for object instantiation.

Removed

Fixed

  • ❗ Format of Update content type using $update->getUpdateContent().

0.43.0 - 2017-04-17

Notes

Added

  • Travis CI webhook for Support Bot.
  • Interval for request limiter.
  • isRunCommands() method to check if called via runCommands().
  • Ensure coding standards for tests folder with phpcs.

Changed

  • Move default commands to examples folder.
  • All links point to new organisation repo.
  • Add PHP 7.1 support and update dependencies.

Fixed

  • Prevent handling the same Telegram updates multiple times, throw exception instead.

0.42.0 - 2017-04-09

Notes

Added

  • Added getBotId() to directly access bot ID.

Changed

  • Rename bot_name to bot_username everywhere.

Deprecated

  • Deprecated Telegram::getBotName() (Use Telegram::getBotUsername() instead).

Fixed

  • Tests are more reliable now, using a properly formatted API key.

0.41.0 - 2017-03-25

Notes

Added

  • $show_in_help attribute for commands, to set if it should be displayed in the /help command.
  • Link to new Telegram group: https://telegram.me/PHP_Telegram_Bot_Support
  • Introduce change log.

0.40.1 - 2017-03-07

Notes

Fixed

  • Infinite message loop, caused by incorrect Entity variable.

0.40.0 - 2017-02-20

Notes

Added

  • Request limiter for incoming requests.

Fixed

  • Faulty formatting in logger.

0.39.0 - 2017-01-20

Notes

Added

  • Newest bot API changes.
  • Allow direct access to PDO object (DB::getPdo()).
  • Simple /debug command that displays various system information to help debugging.
  • Crontab-friendly script.

Changed

  • Botan integration improvements.
  • Make logger more flexible.

Fixed

  • Various bugs and recommendations by Scrutinizer.

0.38.1 - 2016-12-25

Notes

Fixed

  • Usage of self-signed certificates in conjunction with the new allowed_updates webhook parameter.

0.38.0 - 2016-12-25

Notes

Added

  • New switch_inline_query_current_chat option for inline keyboard.
  • Support for channel_post and edited_channel_post.
  • New alias deleteWebhook (for unsetWebhook).

Changed

  • Update WebhookInfo entity and setWebhook to allow passing of new arguments.

0.37.1 - 2016-12-24

Notes

Fixed

  • Keyboards that are built without using the KeyboardButton objects.
  • Commands that are called via /command@botname by correctly passing them the bot name.

0.37.0 - 2016-12-13

Notes

Changed

  • Logging improvements to Botan integration.

Deprecated

  • Move hideKeyboard to removeKeyboard.