Merge pull request php-telegram-bot#189 from jacklul/dbchanges

MBoretto · MBoretto · commit 52e1ef1efa25 · 2016-05-23T23:48:29.000+02:00
chosen_inline_result table and make utf8mb4 default
diff --git a/.travis.yml b/.travis.yml
@@ -1,4 +1,12 @@
-sudo: false
+dist: trusty
+sudo: required
+
+addons:
+    apt:
+        packages:
+            - mysql-server-5.6
+            - mysql-client-core-5.6
+            - mysql-client-5.6
 
 language: php
 
@@ -27,7 +35,7 @@ install:
   - travis_retry composer install --no-interaction
 
 before_script:
-  - mysql -e 'create database telegrambot; use telegrambot; source structure.sql;'
+  - mysql -u root -e 'create database telegrambot; use telegrambot; source structure.sql;'
 
 script:
   - ./vendor/bin/phpunit
diff --git a/src/DB.php b/src/DB.php
@@ -11,9 +11,10 @@
 
 namespace Longman\TelegramBot;
 
+use Longman\TelegramBot\Entities\CallbackQuery;
 use Longman\TelegramBot\Entities\Chat;
+use Longman\TelegramBot\Entities\ChosenInlineResult;
 use Longman\TelegramBot\Entities\InlineQuery;
-use Longman\TelegramBot\Entities\CallbackQuery;
 use Longman\TelegramBot\Entities\Message;
 use Longman\TelegramBot\Entities\Update;
 use Longman\TelegramBot\Entities\User;
@@ -66,17 +67,18 @@ class DB
      * @param array    $credentials  Database connection details
      * @param Telegram $telegram     Telegram object to connect with this object
      * @param string   $table_prefix Table prefix
+     * @param string   $encoding     Database character encoding
      *
      * @return PDO PDO database object
      */
-    public static function initialize(array $credentials, Telegram $telegram, $table_prefix = null)
+    public static function initialize(array $credentials, Telegram $telegram, $table_prefix = null, $encoding = 'utf8mb4')
     {
         if (empty($credentials)) {
             throw new TelegramException('MySQL credentials not provided!');
         }
 
         $dsn = 'mysql:host=' . $credentials['host'] . ';dbname=' . $credentials['database'];
-        $options = [\PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES utf8'];
+        $options = [\PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES ' . $encoding];
         try {
             $pdo = new \PDO($dsn, $credentials['user'], $credentials['password'], $options);
             $pdo->setAttribute(\PDO::ATTR_ERRMODE, \PDO::ERRMODE_WARNING);
@@ -135,12 +137,12 @@ protected static function defineTable()
         if (!defined('TB_INLINE_QUERY')) {
             define('TB_INLINE_QUERY', self::$table_prefix.'inline_query');
         }
+        if (!defined('TB_CHOSEN_INLINE_RESULT')) {
+            define('TB_CHOSEN_INLINE_RESULT', self::$table_prefix.'chosen_inline_result');
+        }
         if (!defined('TB_CALLBACK_QUERY')) {
             define('TB_CALLBACK_QUERY', self::$table_prefix.'callback_query');
         }
-        if (!defined('TB_CHOSEN_INLINE_QUERY')) {
-            define('TB_CHOSEN_INLINE_QUERY', self::$table_prefix.'chosen_inline_query');
-        }
         if (!defined('TB_USER')) {
             define('TB_USER', self::$table_prefix.'user');
         }
@@ -256,14 +258,14 @@ protected static function getTimestamp($time = null)
      * @param int $chat_id
      * @param int $message_id
      * @param int $inline_query_id
-     * @param int $chosen_inline_query_id
+     * @param int $chosen_inline_result_id
      * @param int $callback_query_id
      *
      * @return bool|null
      */
-    public static function insertTelegramUpdate($id, $chat_id, $message_id, $inline_query_id, $chosen_inline_query_id, $callback_query_id)
+    public static function insertTelegramUpdate($id, $chat_id, $message_id, $inline_query_id, $chosen_inline_result_id, $callback_query_id)
     {
-        if (is_null($message_id) && is_null($inline_query_id) && is_null($chosen_inline_query_id) && is_null($callback_query_id)) {
+        if (is_null($message_id) && is_null($inline_query_id) && is_null($chosen_inline_result_id) && is_null($callback_query_id)) {
             throw new TelegramException('Error both query_id and message_id are null');
         }
 
@@ -275,18 +277,18 @@ public static function insertTelegramUpdate($id, $chat_id, $message_id, $inline_
             //telegram_update table
             $sth_insert_telegram_update = self::$pdo->prepare('INSERT IGNORE INTO `' . TB_TELEGRAM_UPDATE . '`
                 (
-                `id`, `chat_id`, `message_id`, `inline_query_id`, `chosen_inline_query_id`, `callback_query_id`
+                `id`, `chat_id`, `message_id`, `inline_query_id`, `chosen_inline_result_id`, `callback_query_id`
                 )
                 VALUES (
-                :id, :chat_id, :message_id, :inline_query_id, :chosen_inline_query_id, :callback_query_id
+                :id, :chat_id, :message_id, :inline_query_id, :chosen_inline_result_id, :callback_query_id
                 )
                 ');
 
             $sth_insert_telegram_update->bindParam(':id', $id, \PDO::PARAM_INT);
             $sth_insert_telegram_update->bindParam(':chat_id', $chat_id, \PDO::PARAM_INT);
             $sth_insert_telegram_update->bindParam(':message_id', $message_id, \PDO::PARAM_INT);
             $sth_insert_telegram_update->bindParam(':inline_query_id', $inline_query_id, \PDO::PARAM_INT);
-            $sth_insert_telegram_update->bindParam(':chosen_inline_query_id', $chosen_inline_query_id, \PDO::PARAM_INT);
+            $sth_insert_telegram_update->bindParam(':chosen_inline_result_id', $chosen_inline_result_id, \PDO::PARAM_INT);
             $sth_insert_telegram_update->bindParam(':callback_query_id', $callback_query_id, \PDO::PARAM_INT);
 
             $status = $sth_insert_telegram_update->execute();
@@ -436,50 +438,10 @@ public static function insertRequest(Update &$update)
             self::insertInlineQueryRequest($inline_query);
             return self::insertTelegramUpdate($update_id, null, null, $inline_query_id, null, null);
         } elseif ($update->getUpdateType() == 'chosen_inline_result') {
-            $chosen_inline_query = $update->getChosenInlineResult();
-
-            if (!self::isDbConnected()) {
-                return false;
-            }
-            try {
-                //Inline query Table
-                $mysql_query = 'INSERT INTO `' . TB_CHOSEN_INLINE_QUERY . '`
-                    (
-                    `result_id`, `user_id`, `location`, `inline_message_id`, `query`, `created_at`
-                    )
-                    VALUES (
-                    :result_id, :user_id, :location, :inline_message_id, :query, :created_at
-                    )';
-
-                $sth_insert_chosen_inline_query = self::$pdo->prepare($mysql_query);
-
-                $date = self::getTimestamp(time());
-                $result_id = $chosen_inline_query->getResultId();
-                $from = $chosen_inline_query->getFrom();
-                $user_id = null;
-                if (is_object($from)) {
-                    $user_id = $from->getId();
-                    self::insertUser($from, $date);
-                }
-
-                $location = $chosen_inline_query->getLocation();
-                $inline_message_id = $chosen_inline_query->getInlineMessageId();
-                $query = $chosen_inline_query->getQuery();
-
-                $sth_insert_chosen_inline_query->bindParam(':result_id', $result_id, \PDO::PARAM_STR);
-                $sth_insert_chosen_inline_query->bindParam(':user_id', $user_id, \PDO::PARAM_INT);
-                $sth_insert_chosen_inline_query->bindParam(':location', $location, \PDO::PARAM_INT);
-                $sth_insert_chosen_inline_query->bindParam(':inline_message_id', $inline_message_id, \PDO::PARAM_INT);
-                $sth_insert_chosen_inline_query->bindParam(':query', $query, \PDO::PARAM_STR);
-                $sth_insert_chosen_inline_query->bindParam(':created_at', $date, \PDO::PARAM_STR);
-
-                $status = $sth_insert_chosen_inline_query->execute();
-                $chosen_inline_query_local_id = self::$pdo->lastInsertId();
-            } catch (PDOException $e) {
-                throw new TelegramException($e->getMessage());
-            }
-
-            return self::insertTelegramUpdate($update_id, null, null, null, $chosen_inline_query_local_id, null);
+            $chosen_inline_result = $update->getChosenInlineResult();
+            self::insertChosenInlineResultRequest($chosen_inline_result);
+            $chosen_inline_result_local_id = self::$pdo->lastInsertId();
+            return self::insertTelegramUpdate($update_id, null, null, null, $chosen_inline_result_local_id, null);
         } elseif ($update->getUpdateType() == 'callback_query') {
             $callback_query = $update->getCallbackQuery();
             $callback_query_id = $callback_query->getId();
@@ -540,6 +502,57 @@ public static function insertInlineQueryRequest(InlineQuery &$inline_query)
         }
     }
 
+    /**
+     * Insert chosen inline result request into database
+     *
+     * @param Entities\ChosenInlineResult &$chosen_inline_result
+     *
+     * @return bool
+     */
+    public static function insertChosenInlineResultRequest(ChosenInlineResult &$chosen_inline_result)
+    {
+        if (!self::isDbConnected()) {
+            return false;
+        }
+        try {
+            //Chosen inline result Table
+            $mysql_query = 'INSERT INTO `' . TB_CHOSEN_INLINE_RESULT . '`
+                    (
+                    `result_id`, `user_id`, `location`, `inline_message_id`, `query`, `created_at`
+                    )
+                    VALUES (
+                    :result_id, :user_id, :location, :inline_message_id, :query, :created_at
+                    )';
+
+            $sth_insert_chosen_inline_result = self::$pdo->prepare($mysql_query);
+
+            $date = self::getTimestamp(time());
+            $result_id = $chosen_inline_result->getResultId();
+            $from = $chosen_inline_result->getFrom();
+            $user_id = null;
+            if (is_object($from)) {
+                $user_id = $from->getId();
+                self::insertUser($from, $date);
+            }
+
+            $location = $chosen_inline_result->getLocation();
+            $inline_message_id = $chosen_inline_result->getInlineMessageId();
+            $query = $chosen_inline_result->getQuery();
+
+            $sth_insert_chosen_inline_result->bindParam(':result_id', $result_id, \PDO::PARAM_STR);
+            $sth_insert_chosen_inline_result->bindParam(':user_id', $user_id, \PDO::PARAM_INT);
+            $sth_insert_chosen_inline_result->bindParam(':location', $location, \PDO::PARAM_INT);
+            $sth_insert_chosen_inline_result->bindParam(':inline_message_id', $inline_message_id, \PDO::PARAM_INT);
+            $sth_insert_chosen_inline_result->bindParam(':query', $query, \PDO::PARAM_STR);
+            $sth_insert_chosen_inline_result->bindParam(':created_at', $date, \PDO::PARAM_STR);
+
+            $status = $sth_insert_chosen_inline_result->execute();
+        } catch (PDOException $e) {
+            throw new TelegramException($e->getMessage());
+        }
+    }
+
+
     /**
      * Insert callback query request into database
      *
@@ -711,6 +724,7 @@ public static function insertMessageRequest(Message &$message)
             $sth->bindParam(':forward_from', $forward_from, \PDO::PARAM_INT);
             $sth->bindParam(':forward_from_chat', $forward_from_chat, \PDO::PARAM_INT);
             $sth->bindParam(':forward_date', $forward_date, \PDO::PARAM_STR);
+
             $reply_chat_id = null;
             if ($reply_to_message_id) {
                 $reply_chat_id = $chat_id;
diff --git a/src/Telegram.php b/src/Telegram.php
@@ -181,9 +181,9 @@ public function __construct($api_key, $bot_name)
      *
      * @return Telegram
      */
-    public function enableMySql(array $credential, $table_prefix = null)
+    public function enableMySql(array $credential, $table_prefix = null, $encoding = 'utf8mb4')
     {
-        $this->pdo = DB::initialize($credential, $this, $table_prefix);
+        $this->pdo = DB::initialize($credential, $this, $table_prefix, $encoding);
         ConversationDB::initializeConversation();
         $this->mysql_enabled = true;
         return $this;
diff --git a/structure.sql b/structure.sql
@@ -7,7 +7,7 @@ CREATE TABLE IF NOT EXISTS  `user` (
   `updated_at` timestamp NULL DEFAULT NULL COMMENT 'Entry date update',
   PRIMARY KEY (`id`),
   KEY `username` (`username`)
-) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_general_ci;
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_520_ci;
 
 CREATE TABLE IF NOT EXISTS  `chat` (
   `id` bigint COMMENT 'Unique user or chat identifier',
@@ -18,7 +18,7 @@ CREATE TABLE IF NOT EXISTS  `chat` (
   `old_id` bigint DEFAULT NULL COMMENT 'Unique chat identifieri this is filled when a chat is converted to a superchat',
    PRIMARY KEY (`id`),
    KEY `old_id` (`old_id`)
-) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_general_ci;
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_520_ci;
 
 CREATE TABLE IF NOT EXISTS  `user_chat` (
   `user_id` bigint COMMENT 'Unique user identifier',
@@ -28,7 +28,7 @@ CREATE TABLE IF NOT EXISTS  `user_chat` (
     ON DELETE CASCADE ON UPDATE CASCADE,
   FOREIGN KEY (`chat_id`) REFERENCES `chat` (`id`)
     ON DELETE CASCADE ON UPDATE CASCADE
-) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_general_ci;
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_520_ci;
 
 CREATE TABLE IF NOT EXISTS `inline_query` (
   `id` bigint UNSIGNED COMMENT 'Unique identifier for this query.',
@@ -40,12 +40,11 @@ CREATE TABLE IF NOT EXISTS `inline_query` (
    PRIMARY KEY (`id`),
    KEY `user_id` (`user_id`),
 
-   FOREIGN KEY (`user_id`)
-   REFERENCES `user` (`id`)
+   FOREIGN KEY (`user_id`) REFERENCES `user` (`id`)
 
-) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_general_ci;
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_520_ci;
 
-CREATE TABLE IF NOT EXISTS `chosen_inline_query` (
+CREATE TABLE IF NOT EXISTS `chosen_inline_result` (
   `id` bigint UNSIGNED AUTO_INCREMENT COMMENT 'Unique identifier for chosen query.',
   `result_id` CHAR(255) NOT NULL DEFAULT '' COMMENT 'Id of the chosen result',
   `user_id` bigint NULL COMMENT 'Sender',
@@ -56,10 +55,9 @@ CREATE TABLE IF NOT EXISTS `chosen_inline_query` (
    PRIMARY KEY (`id`),
    KEY `user_id` (`user_id`),
 
-   FOREIGN KEY (`user_id`)
-   REFERENCES `user` (`id`)
+   FOREIGN KEY (`user_id`) REFERENCES `user` (`id`)
 
-) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_general_ci;
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_520_ci;
 
 CREATE TABLE IF NOT EXISTS `callback_query` (
   `id` bigint UNSIGNED COMMENT 'Unique identifier for this query.',
@@ -71,10 +69,9 @@ CREATE TABLE IF NOT EXISTS `callback_query` (
    PRIMARY KEY (`id`),
    KEY `user_id` (`user_id`),
 
-   FOREIGN KEY (`user_id`)
-   REFERENCES `user` (`id`)
+   FOREIGN KEY (`user_id`) REFERENCES `user` (`id`)
 
-) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_general_ci;
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_520_ci;
 
 CREATE TABLE IF NOT EXISTS  `message` (
   `chat_id` bigint COMMENT 'Chat identifier.',
@@ -86,7 +83,7 @@ CREATE TABLE IF NOT EXISTS  `message` (
   `forward_date` timestamp NULL DEFAULT NULL COMMENT 'For forwarded messages, date the original message was sent in Unix time',
   `reply_to_chat` bigint NULL DEFAULT NULL COMMENT 'Chat identifier.',
   `reply_to_message` bigint UNSIGNED DEFAULT NULL COMMENT 'Message is a reply to another message.',
-  `text` TEXT DEFAULT NULL COMMENT 'For text messages, the actual UTF-8 text of the message max message length 4096 char utf8',
+  `text` TEXT DEFAULT NULL COMMENT 'For text messages, the actual UTF-8 text of the message max message length 4096 char utf8mb4',
   `entities` TEXT DEFAULT NULL COMMENT 'For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text',
   `audio` TEXT DEFAULT NULL COMMENT 'Audio object. Message is an audio file, information about the file',
   `document` TEXT DEFAULT NULL COMMENT 'Document object. Message is a general file, information about the file',
@@ -129,27 +126,27 @@ CREATE TABLE IF NOT EXISTS  `message` (
   FOREIGN KEY (`new_chat_member`) REFERENCES `user` (`id`),
   FOREIGN KEY (`left_chat_member`) REFERENCES `user` (`id`)
 
-) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_general_ci;
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_520_ci;
 
 CREATE TABLE IF NOT EXISTS `telegram_update` (
   `id` bigint UNSIGNED COMMENT 'The update\'s unique identifier.',
   `chat_id` bigint NULL DEFAULT NULL COMMENT 'Chat identifier.',
   `message_id` bigint UNSIGNED DEFAULT NULL COMMENT 'Unique message identifier',
   `inline_query_id` bigint UNSIGNED DEFAULT NULL COMMENT 'The inline query unique identifier.',
-  `chosen_inline_query_id` bigint UNSIGNED DEFAULT NULL COMMENT 'The chosen query unique identifier.',
+  `chosen_inline_result_id` bigint UNSIGNED DEFAULT NULL COMMENT 'The chosen query unique identifier.',
   `callback_query_id` bigint UNSIGNED DEFAULT NULL COMMENT 'The callback query unique identifier.',
 
   PRIMARY KEY (`id`),
   KEY `message_id` (`chat_id`, `message_id`),
   KEY `inline_query_id` (`inline_query_id`),
-  KEY `chosen_inline_query_id` (`chosen_inline_query_id`),
+  KEY `chosen_inline_result_id` (`chosen_inline_result_id`),
   KEY `callback_query_id` (`callback_query_id`),
 
   FOREIGN KEY (`chat_id`, `message_id`) REFERENCES `message` (`chat_id`,`id`),
   FOREIGN KEY (`inline_query_id`) REFERENCES `inline_query` (`id`),
-  FOREIGN KEY (`chosen_inline_query_id`) REFERENCES `chosen_inline_query` (`id`),
+  FOREIGN KEY (`chosen_inline_result_id`) REFERENCES `chosen_inline_result` (`id`),
   FOREIGN KEY (`callback_query_id`) REFERENCES `callback_query` (`id`)
-) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_general_ci;
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_520_ci;
 
 CREATE TABLE IF NOT EXISTS `conversation` (
   `id` bigint(20) unsigned AUTO_INCREMENT COMMENT 'Row unique id',
@@ -166,11 +163,9 @@ CREATE TABLE IF NOT EXISTS `conversation` (
   KEY `chat_id` (`chat_id`),
   KEY `status` (`status`),
 
-  FOREIGN KEY (`user_id`)
-  REFERENCES `user` (`id`),
-  FOREIGN KEY (`chat_id`)
-  REFERENCES `chat` (`id`)
-) ENGINE=InnoDB  DEFAULT CHARSET=utf8 COLLATE=utf8_general_ci;
+  FOREIGN KEY (`user_id`) REFERENCES `user` (`id`),
+  FOREIGN KEY (`chat_id`) REFERENCES `chat` (`id`)
+) ENGINE=InnoDB  DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_520_ci;
 
 CREATE TABLE IF NOT EXISTS `botan_shortener` (
   `id` bigint UNSIGNED AUTO_INCREMENT COMMENT 'Unique identifier for this entry.',
@@ -180,5 +175,6 @@ CREATE TABLE IF NOT EXISTS `botan_shortener` (
   `created_at` timestamp NULL DEFAULT NULL COMMENT 'Entry date creation',
 
   PRIMARY KEY (`id`),
+
   FOREIGN KEY (`user_id`) REFERENCES `user` (`id`)
-) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_general_ci;
+) ENGINE=InnoDB  DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_520_ci;
diff --git a/tests/Unit/ConversationTest.php b/tests/Unit/ConversationTest.php
@@ -35,7 +35,7 @@ protected function setUp()
     {
         $credentials = [
             'host'     => '127.0.0.1',
-            'user'     => 'travis',
+            'user'     => 'root',
             'password' => '',
             'database' => 'telegrambot',
         ];

Original file line number	Diff line number	Diff line change
`@@ -181,9 +181,9 @@ public function __construct($api_key, $bot_name)`
`181`	`181`	`*`
`182`	`182`	`* @return Telegram`
`183`	`183`	`*/`
`184`		`- public function enableMySql(array $credential, $table_prefix = null)`
	`184`	`+ public function enableMySql(array $credential, $table_prefix = null, $encoding = 'utf8mb4')`
`185`	`185`	`{`
`186`		`- $this->pdo = DB::initialize($credential, $this, $table_prefix);`
	`186`	`+ $this->pdo = DB::initialize($credential, $this, $table_prefix, $encoding);`
`187`	`187`	`ConversationDB::initializeConversation();`
`188`	`188`	`$this->mysql_enabled = true;`
`189`	`189`	`return $this;`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ protected function setUp()`
`35`	`35`	`{`
`36`	`36`	`$credentials = [`
`37`	`37`	`'host' => '127.0.0.1',`
`38`		`- 'user' => 'travis',`
	`38`	`+ 'user' => 'root',`
`39`	`39`	`'password' => '',`
`40`	`40`	`'database' => 'telegrambot',`
`41`	`41`	`];`