Merge pull request #940 from noplanman/920-new_system_commands

noplanman · web-flow · commit 0efd56773d36 · 2019-03-23T22:51:15.000+01:00
Autoselect SystemCommand from existing Commands
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,8 +6,10 @@ Exclamation symbols (:exclamation:) note something of importance e.g. breaking c
 ## [Unreleased]
 ### Added
 ### Changed
+- All Message field types dynamically search for an existing Command class that can handle them.
 ### Deprecated
 - Botan.io service has been discontinued.
+- Most built-in System Commands will be handled by GenericmessageCommand by default in a future release and will require a custom implementation.
 ### Removed
 ### Fixed
 - Constraint errors in `/cleanup` command.
diff --git a/src/Commands/SystemCommands/ChannelchatcreatedCommand.php b/src/Commands/SystemCommands/ChannelchatcreatedCommand.php
@@ -14,6 +14,8 @@
 
 /**
  * Channel chat created command
+ *
+ * @todo Remove due to deprecation!
  */
 class ChannelchatcreatedCommand extends SystemCommand
 {
@@ -43,6 +45,8 @@ public function execute()
         //$message = $this->getMessage();
         //$channel_chat_created = $message->getChannelChatCreated();
 
+        trigger_error(__CLASS__ . ' is deprecated and will be removed and handled by ' . GenericmessageCommand::class . ' by default in a future release.', E_USER_DEPRECATED);
+
         return parent::execute();
     }
 }
diff --git a/src/Commands/SystemCommands/ChannelpostCommand.php b/src/Commands/SystemCommands/ChannelpostCommand.php
@@ -14,6 +14,8 @@
 
 /**
  * Channel post command
+ *
+ * @todo Remove due to deprecation!
  */
 class ChannelpostCommand extends SystemCommand
 {
@@ -42,6 +44,8 @@ public function execute()
     {
         //$channel_post = $this->getUpdate()->getChannelPost();
 
+        trigger_error(__CLASS__ . ' is deprecated and will be removed and handled by ' . GenericmessageCommand::class . ' by default in a future release.', E_USER_DEPRECATED);
+
         return parent::execute();
     }
 }
diff --git a/src/Commands/SystemCommands/ChoseninlineresultCommand.php b/src/Commands/SystemCommands/ChoseninlineresultCommand.php
@@ -14,6 +14,8 @@
 
 /**
  * Chosen inline result command
+ *
+ * @todo Remove due to deprecation!
  */
 class ChoseninlineresultCommand extends SystemCommand
 {
@@ -45,6 +47,8 @@ public function execute()
         //$inline_query = $update->getChosenInlineResult();
         //$query = $inline_query->getQuery();
 
+        trigger_error(__CLASS__ . ' is deprecated and will be removed and handled by ' . GenericmessageCommand::class . ' by default in a future release.', E_USER_DEPRECATED);
+
         return parent::execute();
     }
 }
diff --git a/src/Commands/SystemCommands/DeletechatphotoCommand.php b/src/Commands/SystemCommands/DeletechatphotoCommand.php
@@ -14,6 +14,8 @@
 
 /**
  * Delete chat photo command
+ *
+ * @todo Remove due to deprecation!
  */
 class DeletechatphotoCommand extends SystemCommand
 {
@@ -43,6 +45,8 @@ public function execute()
         //$message = $this->getMessage();
         //$delete_chat_photo = $message->getDeleteChatPhoto();
 
+        trigger_error(__CLASS__ . ' is deprecated and will be removed and handled by ' . GenericmessageCommand::class . ' by default in a future release.', E_USER_DEPRECATED);
+
         return parent::execute();
     }
 }
diff --git a/src/Commands/SystemCommands/EditedchannelpostCommand.php b/src/Commands/SystemCommands/EditedchannelpostCommand.php
@@ -14,6 +14,8 @@
 
 /**
  * Edited channel post command
+ *
+ * @todo Remove due to deprecation!
  */
 class EditedchannelpostCommand extends SystemCommand
 {
@@ -42,6 +44,8 @@ public function execute()
     {
         //$edited_channel_post = $this->getUpdate()->getEditedChannelPost();
 
+        trigger_error(__CLASS__ . ' is deprecated and will be removed and handled by ' . GenericmessageCommand::class . ' by default in a future release.', E_USER_DEPRECATED);
+
         return parent::execute();
     }
 }
diff --git a/src/Commands/SystemCommands/EditedmessageCommand.php b/src/Commands/SystemCommands/EditedmessageCommand.php
@@ -14,6 +14,8 @@
 
 /**
  * Edited message command
+ *
+ * @todo Remove due to deprecation!
  */
 class EditedmessageCommand extends SystemCommand
 {
@@ -43,6 +45,8 @@ public function execute()
         //$update = $this->getUpdate();
         //$edited_message = $update->getEditedMessage();
 
+        trigger_error(__CLASS__ . ' is deprecated and will be removed and handled by ' . GenericmessageCommand::class . ' by default in a future release.', E_USER_DEPRECATED);
+
         return parent::execute();
     }
 }
diff --git a/src/Commands/SystemCommands/GroupchatcreatedCommand.php b/src/Commands/SystemCommands/GroupchatcreatedCommand.php
@@ -14,6 +14,8 @@
 
 /**
  * Group chat created command
+ *
+ * @todo Remove due to deprecation!
  */
 class GroupchatcreatedCommand extends SystemCommand
 {
@@ -43,6 +45,8 @@ public function execute()
         //$message = $this->getMessage();
         //$group_chat_created = $message->getGroupChatCreated();
 
+        trigger_error(__CLASS__ . ' is deprecated and will be removed and handled by ' . GenericmessageCommand::class . ' by default in a future release.', E_USER_DEPRECATED);
+
         return parent::execute();
     }
 }
diff --git a/src/Commands/SystemCommands/LeftchatmemberCommand.php b/src/Commands/SystemCommands/LeftchatmemberCommand.php
@@ -14,6 +14,8 @@
 
 /**
  * Left chat member command
+ *
+ * @todo Remove due to deprecation!
  */
 class LeftchatmemberCommand extends SystemCommand
 {
@@ -43,6 +45,8 @@ public function execute()
         //$message = $this->getMessage();
         //$member = $message->getLeftChatMember();
 
+        trigger_error(__CLASS__ . ' is deprecated and will be removed and handled by ' . GenericmessageCommand::class . ' by default in a future release.', E_USER_DEPRECATED);
+
         return parent::execute();
     }
 }
diff --git a/src/Commands/SystemCommands/MigratefromchatidCommand.php b/src/Commands/SystemCommands/MigratefromchatidCommand.php
@@ -14,6 +14,8 @@
 
 /**
  * Migrate from chat id command
+ *
+ * @todo Remove due to deprecation!
  */
 class MigratefromchatidCommand extends SystemCommand
 {
@@ -43,6 +45,8 @@ public function execute()
         //$message = $this->getMessage();
         //$migrate_from_chat_id = $message->getMigrateFromChatId();
 
+        trigger_error(__CLASS__ . ' is deprecated and will be removed and handled by ' . GenericmessageCommand::class . ' by default in a future release.', E_USER_DEPRECATED);
+
         return parent::execute();
     }
 }
diff --git a/src/Commands/SystemCommands/MigratetochatidCommand.php b/src/Commands/SystemCommands/MigratetochatidCommand.php
@@ -14,6 +14,8 @@
 
 /**
  * Migrate to chat id command
+ *
+ * @todo Remove due to deprecation!
  */
 class MigratetochatidCommand extends SystemCommand
 {
@@ -43,6 +45,8 @@ public function execute()
         //$message = $this->getMessage();
         //$migrate_to_chat_id = $message->getMigrateToChatId();
 
+        trigger_error(__CLASS__ . ' is deprecated and will be removed and handled by ' . GenericmessageCommand::class . ' by default in a future release.', E_USER_DEPRECATED);
+
         return parent::execute();
     }
 }
diff --git a/src/Commands/SystemCommands/NewchatmembersCommand.php b/src/Commands/SystemCommands/NewchatmembersCommand.php
@@ -14,6 +14,8 @@
 
 /**
  * New chat members command
+ *
+ * @todo Remove due to deprecation!
  */
 class NewchatmembersCommand extends SystemCommand
 {
@@ -43,6 +45,8 @@ public function execute()
         //$message = $this->getMessage();
         //$members = $message->getNewChatMembers();
 
+        trigger_error(__CLASS__ . ' is deprecated and will be removed and handled by ' . GenericmessageCommand::class . ' by default in a future release.', E_USER_DEPRECATED);
+
         return parent::execute();
     }
 }
diff --git a/src/Commands/SystemCommands/NewchatphotoCommand.php b/src/Commands/SystemCommands/NewchatphotoCommand.php
@@ -14,6 +14,8 @@
 
 /**
  * New chat photo command
+ *
+ * @todo Remove due to deprecation!
  */
 class NewchatphotoCommand extends SystemCommand
 {
@@ -43,6 +45,8 @@ public function execute()
         //$message = $this->getMessage();
         //$new_chat_photo = $message->getNewChatPhoto();
 
+        trigger_error(__CLASS__ . ' is deprecated and will be removed and handled by ' . GenericmessageCommand::class . ' by default in a future release.', E_USER_DEPRECATED);
+
         return parent::execute();
     }
 }
diff --git a/src/Commands/SystemCommands/NewchattitleCommand.php b/src/Commands/SystemCommands/NewchattitleCommand.php
@@ -14,6 +14,8 @@
 
 /**
  * New chat title command
+ *
+ * @todo Remove due to deprecation!
  */
 class NewchattitleCommand extends SystemCommand
 {
@@ -43,6 +45,8 @@ public function execute()
         //$message = $this->getMessage();
         //$new_chat_title = $message->getNewChatTitle();
 
+        trigger_error(__CLASS__ . ' is deprecated and will be removed and handled by ' . GenericmessageCommand::class . ' by default in a future release.', E_USER_DEPRECATED);
+
         return parent::execute();
     }
 }
diff --git a/src/Commands/SystemCommands/PinnedmessageCommand.php b/src/Commands/SystemCommands/PinnedmessageCommand.php
@@ -14,6 +14,8 @@
 
 /**
  * Pinned message command
+ *
+ * @todo Remove due to deprecation!
  */
 class PinnedmessageCommand extends SystemCommand
 {
@@ -43,6 +45,8 @@ public function execute()
         //$message = $this->getMessage();
         //$pinned_message = $message->getPinnedMessage();
 
+        trigger_error(__CLASS__ . ' is deprecated and will be removed and handled by ' . GenericmessageCommand::class . ' by default in a future release.', E_USER_DEPRECATED);
+
         return parent::execute();
     }
 }
diff --git a/src/Commands/SystemCommands/StartCommand.php b/src/Commands/SystemCommands/StartCommand.php
@@ -15,6 +15,8 @@
 
 /**
  * Start command
+ *
+ * @todo Remove due to deprecation!
  */
 class StartCommand extends SystemCommand
 {
@@ -50,6 +52,8 @@ public function execute()
         //$chat_id = $message->getChat()->getId();
         //$user_id = $message->getFrom()->getId();
 
+        trigger_error(__CLASS__ . ' is deprecated and will be removed and handled by ' . GenericmessageCommand::class . ' by default in a future release.', E_USER_DEPRECATED);
+
         return parent::execute();
     }
 }
diff --git a/src/Commands/SystemCommands/SupergroupchatcreatedCommand.php b/src/Commands/SystemCommands/SupergroupchatcreatedCommand.php
@@ -14,6 +14,8 @@
 
 /**
  * Super group chat created command
+ *
+ * @todo Remove due to deprecation!
  */
 class SupergroupchatcreatedCommand extends SystemCommand
 {
@@ -43,6 +45,8 @@ public function execute()
         //$message = $this->getMessage();
         //$supergroup_chat_created = $message->getSuperGroupChatCreated();
 
+        trigger_error(__CLASS__ . ' is deprecated and will be removed and handled by ' . GenericmessageCommand::class . ' by default in a future release.', E_USER_DEPRECATED);
+
         return parent::execute();
     }
 }
diff --git a/src/Telegram.php b/src/Telegram.php
@@ -445,47 +445,36 @@ public function processUpdate(Update $update)
         $this->update = $update;
         $this->last_update_id = $update->getUpdateId();
 
+        //Load admin commands
+        if ($this->isAdmin()) {
+            $this->addCommandsPath(TB_BASE_COMMANDS_PATH . '/AdminCommands', false);
+        }
+
+        //Make sure we have an up-to-date command list
+        //This is necessary to "require" all the necessary command files!
+        $this->getCommandsList();
+
         //If all else fails, it's a generic message.
         $command = 'genericmessage';
 
         $update_type = $this->update->getUpdateType();
         if ($update_type === 'message') {
             $message = $this->update->getMessage();
-
-            //Load admin commands
-            if ($this->isAdmin()) {
-                $this->addCommandsPath(TB_BASE_COMMANDS_PATH . '/AdminCommands', false);
-            }
-
-            $type = $message->getType();
+            $type    = $message->getType();
             if ($type === 'command') {
                 $command = $message->getCommand();
-            } elseif (in_array($type, [
-                'new_chat_members',
-                'left_chat_member',
-                'new_chat_title',
-                'new_chat_photo',
-                'delete_chat_photo',
-                'group_chat_created',
-                'supergroup_chat_created',
-                'channel_chat_created',
-                'migrate_to_chat_id',
-                'migrate_from_chat_id',
-                'pinned_message',
-                'invoice',
-                'successful_payment',
-            ], true)
-            ) {
-                $command = $this->getCommandFromType($type);
+            } else {
+                // Let's check if the message object has the type field we're looking for
+                // and if a fitting command class is available.
+                $command_tmp = $this->getCommandFromType($type);
+                if ($this->getCommandObject($command_tmp) !== null) {
+                    $command = $command_tmp;
+                }
             }
         } else {
             $command = $this->getCommandFromType($update_type);
         }
 
-        //Make sure we have an up-to-date command list
-        //This is necessary to "require" all the necessary command files!
-        $this->getCommandsList();
-
         //Make sure we don't try to process update that was already processed
         $last_id = DB::selectTelegramUpdate(1, $this->update->getUpdateId());
         if ($last_id && count($last_id) === 1) {

Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,8 @@`
`14`	`14`
`15`	`15`	`/**`
`16`	`16`	`* Channel chat created command`
	`17`	`+ *`
	`18`	`+ * @todo Remove due to deprecation!`
`17`	`19`	`*/`
`18`	`20`	`class ChannelchatcreatedCommand extends SystemCommand`
`19`	`21`	`{`
`@@ -43,6 +45,8 @@ public function execute()`
`43`	`45`	`//$message = $this->getMessage();`
`44`	`46`	`//$channel_chat_created = $message->getChannelChatCreated();`
`45`	`47`
	`48`	`+ trigger_error(__CLASS__ . ' is deprecated and will be removed and handled by ' . GenericmessageCommand::class . ' by default in a future release.', E_USER_DEPRECATED);`
	`49`	`+`
`46`	`50`	`return parent::execute();`
`47`	`51`	`}`
`48`	`52`	`}`