Introducing Admin Interface and ServerResponse type

Author: MBoretto

README.md

@@ -13,7 +13,7 @@
 A Telegram Bot based on the official [Telegram Bot API](https://core.telegram.org/bots/api)
 
 
-## introduction
+## Introduction
 This is a pure php Telegram Bot, fully extensible via plugins. Telegram recently announced official support for a [Bot API](https://telegram.org/blog/bot-revolution) allowing integrators of all sorts to bring automated interactions to the mobile platform. This Bot aims to provide a platform where one could simply write a plugin and have interactions in a matter of minutes.
 The Bot supports Reply Markup and handle commands in group chat with multiple bot.
 
@@ -139,6 +139,7 @@ try {
 }
 ```
 
+##MySQL storage
 If you want insert in database messages/users for further usage in commands, create database and import structure.sql and enable mysql support after object creation and BEFORE handle method
 
 ```php
@@ -154,8 +155,7 @@ $telegram->enableMySQL($credentials, $BOT_NAME.'_');
 
 ```
 
-Commads
---------------
+##Commands
 The bot is able to recognise commands in chat with multiple bot.
 It can execute command triggering a chat event. Here's the list:
 
@@ -165,23 +165,31 @@ It can execute command triggering a chat event. Here's the list:
 - New chat title (**NewchattitleCommand.php**)
 - Left chat participant (**LeftchatparticipantCommand.php**)
 
-**GenericCommand.php** let you handle commands that non exist or use commands as var:  
-Favourite colour? **/black /red**  
-Favourite number? **/1 /134**  
+**GenericCommand.php** let you handle commands that non exists or use commands as variable:  
+Favourite colour? **/black, /red**  
+Favourite number? **/1, /134**  
 
 
-Maybe you would like to develop your own commands. A good practice is to store them outside vendor/. This can be done adding before the method:
+Maybe you would like to develop your own commands. A good practice is to store them outside vendor/. This can be done adding the method:
 
 ```php
 $COMMANDS_FOLDER = __DIR__.'/Commands/';
 $telegram->addCommandsPath($COMMANDS_FOLDER);
 
 ```
 
+##Admin Commands (new!)
+Enabling this feature, the admin bot can perform some super user command like send message to all.  
+You can specify one or more admin with this option:
 
+```php
+$telegram->enableAdmins(array('TelegramUserID','Othersid'));
+```
+Telegram user id can be retrieved with the command /whoami.
+Admin commands are stored in src/Admin/ folder.
+To know all the commands avaiable type /help. 
 
-Send message to all active chats (new!)
----------------------------------------
+##Send message to all active chats
 To do this you have to enable the mysql connection.
 Here's an example of use:
 
@@ -198,8 +206,7 @@ $results = $telegram->sendToActiveChats(
 print_r($results);
 ```
 
-Utilis
-------
+##Utilis
 You can also log incoming messages on a text file, set this option with the methods:
 ```php
 $telegram->setLogRequests(true);
@@ -210,14 +217,12 @@ $telegram->setLogPath($BOT_NAME.'.log');
 This code is available on [Github][0]. Pull requests are welcome.
 
 
-Troubleshooting
--------------
+##Troubleshooting
 
 If you like living on the edge, please report any bugs you find on the [PHP Telegram Bot issues](https://github.com/akalongman/php-telegram-bot/issues) page.
 
 
-Contributing
--------------
+##Contributing
 
 See [CONTRIBUTING.md](CONTRIBUTING.md) for information.
 

src/Admin/.SendtoallCommand.php.swp

@@ -0,0 +1,91 @@
+<?php
+
+/*
+ * This file is part of the TelegramBot package.
+ *
+ * (c) Avtandil Kikabidze aka LONGMAN <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+*/
+namespace Longman\TelegramBot\Commands;
+
+use Longman\TelegramBot\Request;
+use Longman\TelegramBot\Command;
+use Longman\TelegramBot\Entities\Update;
+use Longman\TelegramBot\Exception\TelegramException;
+
+class SendtoallCommand extends Command
+{
+    protected $name = 'sendall';
+    protected $description = 'Send the message to all the user\'s bot';
+    protected $usage = '/sendall <message to send>';
+    protected $version = '1.2.0';
+    protected $enabled = true;
+    protected $public = true;
+
+
+    public function execute()
+    {
+        $update = $this->getUpdate();
+        $message = $this->getMessage();
+
+        $chat_id = $message->getChat()->getId();
+        $message_id = $message->getMessageId();
+        $text = $message->getText(true);
+
+        if (empty($text)) {
+            $text = 'Write te message to sent: /sendall <message>';
+        } else {
+            $results = $this->telegram->sendToActiveChats(
+                'sendMessage', //callback function to execute (see Request.php methods)
+                array('text'=> $text), //Param to evaluate the request
+                true, //Send to chats (group chat)
+                true, //Send to users (single chat)
+                null, //'yyyy-mm-dd hh:mm:ss' date range from
+                null  //'yyyy-mm-dd hh:mm:ss' date range to
+            );
+
+            $tot = 0;
+            $fail = 0;
+
+            $text = "Message sended to:\n";
+            foreach ($results as $result) {
+                $status = '';
+                $type = '';
+                print_r($result);
+                if ($result->isOk()) {
+                    $status = '✔️';
+
+                    $ServerResponse = $result->getResult();
+                    $chat = $ServerResponse->getChat();
+                    if ($chat->isSingleChat()) {
+                        $name = $chat->getFirstName();
+                        $type = 'user';
+                    } else {
+                        $name = $chat->getTitle();
+                        $type = 'chat';
+                    }
+                } else {
+                    $status = '✖️';
+                    ++$fail;
+                }
+                ++$tot;
+
+                $text .= $tot.') '.$status.' '.$type.' '.$name."\n";
+            }
+            $text .= "Delivered: ".($tot - $fail).'/'.$tot."\n";
+        }
+        if ($tot == 0) {
+            $text = "No users or chats found..";
+        }
+
+        $data = array();
+        $data['chat_id'] = $chat_id;
+        //$data['reply_to_message_id'] = $message_id;
+        $data['text'] = $text;
+
+        $result = Request::sendMessage($data);
+        return $result;
+    }
+}

src/Admin/SendtoallCommand.php

@@ -17,7 +17,7 @@
 class GenericCommand extends Command
 {
     protected $name = 'Generic';
-    protected $description = 'Handle genric commands or is executed by defaul when a command is not found';
+    protected $description = 'Handle generic commands or is executed by defaul when a command is not found';
     protected $usage = '/';
     protected $version = '1.0.0';
     protected $enabled = true;
@@ -26,9 +26,12 @@ public function execute()
     {
         $update = $this->getUpdate();
         $message = $this->getMessage();
+        $chat_id = $message->getChat()->getId();
         //you can use $command as param
         $command = $message->getCommand();
 
+        $data = [];
+        $data['chat_id'] = $chat_id;
         $data['text'] = 'Command: '.$command.' not found.. :(';
         $result = Request::sendMessage($data);
         return $result;

src/Commands/GenericCommand.php

@@ -0,0 +1,60 @@
+<?php
+
+/*
+ * This file is part of the TelegramBot package.
+ *
+ * (c) Avtandil Kikabidze aka LONGMAN <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+*/
+namespace Longman\TelegramBot\Entities;
+
+use Longman\TelegramBot\Exception\TelegramException;
+
+class Audio extends Entity
+{
+    protected $file_id;
+    protected $duration;
+    protected $mime_type;
+    protected $file_size;
+
+
+    public function __construct(array $data)
+    {
+
+        $this->file_id = isset($data['file_id']) ? $data['file_id'] : null;
+        if (empty($this->file_id)) {
+            throw new TelegramException('file_id is empty!');
+        }
+
+        $this->width = isset($data['duration']) ? $data['duration'] : null;
+        if (empty($this->duration)) {
+            throw new TelegramException('duration is empty!');
+        }
+
+        $this->height = isset($data['mime_type']) ? $data['mime_type'] : null;
+        $this->file_size = isset($data['file_size']) ? $data['file_size'] : null;
+
+    }
+
+    public function getFileId()
+    {
+        return $this->file_id;
+    }
+
+    public function getiDuration()
+    {
+         return $this->duration;
+    }
+
+    public function getMimeType()
+    {
+         return $this->mime_type;
+    }
+
+    public function getFileSize()
+    {
+         return $this->file_size;
+    }
+}

src/Entities/Audio.php

@@ -34,7 +34,19 @@ public function __construct(array $data)
         $this->last_name = isset($data['last_name']) ? $data['last_name'] : null;
         $this->username = isset($data['username']) ? $data['username'] : null;
     }
+    public function isGroupChat()
+    {
+        if ($this->id < 0) {
+            return true;
+        } else {
+            return false;
+        }
+    }
 
+    public function isSingleChat()
+    {
+        return ! $this->isGroupChat();
+    }
     public function getId()
     {
 

src/Entities/Chat.php

@@ -0,0 +1,59 @@
+<?php
+
+/*
+ * This file is part of the TelegramBot package.
+ *
+ * (c) Avtandil Kikabidze aka LONGMAN <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+*/
+namespace Longman\TelegramBot\Entities;
+
+use Longman\TelegramBot\Exception\TelegramException;
+
+class Contact extends Entity
+{
+
+    protected $phone_number;
+    protected $first_name;
+    protected $last_name;
+    protected $user_id;
+
+    public function __construct(array $data)
+    {
+
+        $this->phone_number = isset($data['phone_number']) ? $data['phone_number'] : null;
+        if (empty($this->phone_number)) {
+            throw new TelegramException('phone_number is empty!');
+        }
+
+        $this->first_name = isset($data['first_name']) ? $data['first_name'] : null;
+        if (empty($this->first_name)) {
+            throw new TelegramException('first_name is empty!');
+        }
+
+        $this->last_name = isset($data['last_name']) ? $data['last_name'] : null;
+        $this->user_id = isset($data['user_id']) ? $data['user_id'] : null;
+    }
+
+    public function getPhoneNumber()
+    {
+        return $this->phone_number;
+    }
+
+    public function getFirstName()
+    {
+        return $this->first_name;
+    }
+
+    public function getLastName()
+    {
+        return $this->last_name;
+    }
+
+    public function getUserId()
+    {
+        return $this->user_id;
+    }
+}