New command parameter to enforce usage in private chats only.

Author: noplanman

src/Commands/AdminCommands/CleanupCommand.php

@@ -62,6 +62,11 @@ class CleanupCommand extends AdminCommand
      */
     protected $need_mysql = true;
 
+    /**
+     * @var bool
+     */
+    protected $private_only = true;
+
     /**
      * Default tables to clean, cleaning 'chat', 'user' and 'user_chat' by default is bad practice!
      *
@@ -351,20 +356,14 @@ public function executeNoDb()
     public function execute()
     {
         $message = $this->getMessage();
-        $chat_id = $message->getChat()->getId();
+        $user_id = $message->getFrom()->getId();
         $text    = $message->getText(true);
 
         $data = [
-            'chat_id'    => $chat_id,
+            'chat_id'    => $user_id,
             'parse_mode' => 'Markdown',
         ];
 
-        if (!$message->getChat()->isPrivateChat()) {
-            $data['text'] = '/cleanup command is only available in a private chat.';
-
-            return Request::sendMessage($data);
-        }
-
         $settings = $this->getSettings($text);
         $queries  = $this->getQueries($settings);
 

src/Commands/Command.php

@@ -97,6 +97,13 @@ abstract class Command
      */
     protected $need_mysql = false;
 
+    /**
+     * Make sure this command only executes on a private chat.
+     *
+     * @var bool
+     */
+    protected $private_only = false;
+
     /**
      * Command config
      *
@@ -145,6 +152,27 @@ public function preExecute()
             return $this->executeNoDb();
         }
 
+        if ($this->isPrivateOnly() && $this->removeNonPrivateMessage()) {
+            $message = $this->getMessage();
+            $chat    = $message->getChat();
+            $user    = $message->getFrom();
+
+            // @todo Deleting a message from a channel isn't working yet.
+            if ($user !== null && !$chat->isChannel()) {
+                return Request::sendMessage([
+                    'chat_id'    => $user->getId(),
+                    'parse_mode' => 'Markdown',
+                    'text'       => sprintf(
+                        "/%s command is only available in a private chat.\n(`%s`)",
+                        $this->getName(),
+                        $message->getText()
+                    ),
+                ]);
+            }
+
+            return Request::emptyResponse();
+        }
+
         return $this->execute();
     }
 
@@ -296,6 +324,16 @@ public function isEnabled()
         return $this->enabled;
     }
 
+    /**
+     * If this command is intended for private chats only.
+     *
+     * @return bool
+     */
+    public function isPrivateOnly()
+    {
+        return $this->private_only;
+    }
+
     /**
      * If this is a SystemCommand
      *
@@ -325,4 +363,27 @@ public function isUserCommand()
     {
         return ($this instanceof UserCommand);
     }
+
+    /**
+     * Delete the current message if it has been called in a non-private chat.
+     *
+     * @return bool
+     */
+    protected function removeNonPrivateMessage()
+    {
+        $message = $this->getMessage();
+        $chat    = $message->getChat();
+
+        if (!$chat->isPrivateChat()) {
+            // Delete the falsely called command message.
+            Request::deleteMessage([
+                'chat_id'    => $chat->getId(),
+                'message_id' => $message->getMessageId(),
+            ]);
+
+            return true;
+        }
+
+        return false;
+    }
 }