CharlotteDunois\Livia\Providers\MySQLProvider

Complexity

Total Complexity

22

Size/Duplication

Total Lines	214
Duplicated Lines	0 %

Importance

Changes	20
Bugs	0	Features	0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	20	3
A	getDB()	0	2	1
A	destroy()	0	4	1
A	__construct()	0	5	1
A	set()	0	16	2
A	remove()	0	18	2
A	create()	0	13	3
A	clear()	0	6	1
A	runQuery()	0	2	1
A	__wakeup()	0	2	1
A	loadRow()	0	15	3
A	get()	0	16	3

<?php
/**
 * Livia
 * Copyright 2017-2019 Charlotte Dunois, All Rights Reserved
 *
 * Website: https://charuru.moe
 * License: https://github.com/CharlotteDunois/Livia/blob/master/LICENSE
*/

namespace CharlotteDunois\Livia\Providers;

/**
 * Loads and stores settings associated with guilds in a MySQL database. Requires the composer package react/mysql.
 */
class MySQLProvider extends SettingProvider {
    /**
     * The DB connection.
     * @var \React\MySQL\ConnectionInterface
     */
    protected $db;
    
    /**
     * A collection of a guild's settings, mapped by guild ID.
     * @var \CharlotteDunois\Collect\Collection
     */
    protected $settings;
    
    /**
     * Constructs a new instance.
     * @param \React\MySQL\ConnectionInterface  $db
     */
    function __construct(\React\MySQL\ConnectionInterface $db) {
        $this->db = $db;
        $this->providerState = \CharlotteDunois\Livia\Providers\SettingProvider::STATE_READY;
        
        $this->settings = new \CharlotteDunois\Collect\Collection();
    }
    
    /**
     * Resets the state.
     * @return void
     * @internal
     */
    function __wakeup() {
        $this->providerState = \CharlotteDunois\Livia\Providers\SettingProvider::STATE_IDLE;
    }
    
    /**
     * Returns the MySQL connection.
     * @return \React\MySQL\ConnectionInterface
     */
    function getDB() {
        return $this->db;
    }
    
    /**
     * {@inheritdoc}
     * @return \React\Promise\ExtendedPromiseInterface
     */
    function destroy() {
        $this->removeListeners();
        
        return $this->db->quit();
    }
    
    /**
     * {@inheritdoc}
     * @return \React\Promise\ExtendedPromiseInterface
     */
    function init(\CharlotteDunois\Livia\Client $client): \React\Promise\ExtendedPromiseInterface {
        $this->client = $client;
        $this->attachListeners();
        
        return (new \React\Promise\Promise(function (callable $resolve, callable $reject) {
            $this->runQuery('CREATE TABLE IF NOT EXISTS `settings` (`guild` VARCHAR(20) NOT NULL, `settings` TEXT NOT NULL, PRIMARY KEY (`guild`))')->then(function () {
                return $this->runQuery('SELECT * FROM `settings`')->then(function ($result) {
                    foreach($result->resultRows as $row) {
                        $this->loadRow($row);
                    }
                    
                    if($this->settings->has('global')) {
                        return null;
                    }
                    
                    return $this->create('global')->then(function () {
                        return null;
                    });
                });
            })->done($resolve, $reject);
        }));
    }
    
    /**
     * Creates a new table row in the db for the guild, if it doesn't exist already - otherwise loads the row.
     * @param string|\CharlotteDunois\Yasmin\Models\Guild  $guild
     * @param array|\ArrayObject                           $settings
     * @return \React\Promise\ExtendedPromiseInterface
     * @throws \InvalidArgumentException
     */
    function create($guild, $settings = array()): \React\Promise\ExtendedPromiseInterface {
        $guild = $this->getGuildID($guild);
        
        return $this->runQuery('SELECT * FROM `settings` WHERE `guild` = ?', array($guild))->then(function ($result) use ($guild, $settings) {
            if(empty($result->resultRows)) {
                if(!($settings instanceof \ArrayObject)) {
                    $settings = new \ArrayObject($settings, \ArrayObject::ARRAY_AS_PROPS);
                }
                
                $this->settings->set($guild, $settings);
                return $this->runQuery('INSERT INTO `settings` (`guild`, `settings`) VALUES (?, ?)', array($guild, \json_encode($settings)));
            } else {
                $this->loadRow($result->resultRows[0]);
            }
        });
    }
    
    /**
     * {@inheritdoc}
     * @return mixed
     */
    function get($guild, string $key, $defaultValue = null) {
        $guild = $this->getGuildID($guild);
        
        if($this->settings->get($guild) === null) {
            $this->client->emit('warn', 'Settings of specified guild is not loaded - loading row - returning default value');
            
            $this->create($guild);
            return $defaultValue;
        }
        
        $settings = $this->settings->get($guild);
        if(\array_key_exists($key, $settings)) {
            return $settings[$key];
        }
        
        return $defaultValue;
    }
    
    /**
     * {@inheritdoc}
     * @return \React\Promise\ExtendedPromiseInterface
     */
    function set($guild, string $key, $value) {
        $guild = $this->getGuildID($guild);
        
        if($this->settings->get($guild) === null) {
            return $this->create($guild)->then(function () use ($guild, $key, $value) {
                $settings = $this->settings->get($guild);
                $settings[$key] = $value;
            
                return $this->runQuery('UPDATE `settings` SET `settings` = ? WHERE `guild` = ?', array(\json_encode($settings), $guild));
            });
        }
        
        $settings = $this->settings->get($guild);
        $settings[$key] = $value;
        
        return $this->runQuery('UPDATE `settings` SET `settings` = ? WHERE `guild` = ?', array(\json_encode($settings), $guild));
    }
    
    /**
     * {@inheritdoc}
     * @return \React\Promise\ExtendedPromiseInterface
     */
    function remove($guild, string $key) {
        $guild = $this->getGuildID($guild);
        
        if($this->settings->get($guild) === null) {
            $this->client->emit('warn', 'Settings of specified guild is not loaded - loading row');
            
            return $this->create($guild)->then(function () use ($guild, $key) {
                $settings = $this->settings->get($guild);
                unset($settings[$key]);
            
                return $this->runQuery('UPDATE `settings` SET `settings` = ? WHERE `guild` = ?', array(\json_encode($settings), $guild));
            });
        }
        
        $settings = $this->settings->get($guild);
        unset($settings[$key]);
        
        return $this->runQuery('UPDATE `settings` SET `settings` = ? WHERE `guild` = ?', array(\json_encode($settings), $guild));
    }
    
    /**
     * {@inheritdoc}
     * @return \React\Promise\ExtendedPromiseInterface
     */
    function clear($guild) {
        $guild = $this->getGuildID($guild);
        
        return (new \React\Promise\Promise(function (callable $resolve, callable $reject) use ($guild) {
            $this->settings->delete($guild);
            $this->runQuery('DELETE FROM `settings` WHERE `guild` = ?', array($guild))->done($resolve, $reject);
        }));
    }
    
    /**
     * Runs a SQL query. Resolves with the QueryResult instance.
     * @param string  $sql
     * @param array   $parameters  Parameters for the query - these get escaped
     * @return \React\Promise\ExtendedPromiseInterface
     * @see https://github.com/friends-of-reactphp/mysql/blob/master/src/QueryResult.php
     */
    function runQuery(string $sql, array $parameters = array()) {
        return $this->db->query($sql, $parameters);
    }
    
    /**
     * Processes a database row.
     * @param array  $row
     * @return void
     */
    protected function loadRow(array $row) {
        $settings = \json_decode($row['settings'], true);
        if($settings === null) {
            $this->client->emit('warn', 'MySQLProvider couldn\'t parse the settings stored for guild "'.$row['guild'].'". Error: '.\json_last_error_msg());
            return;
        }
        
        $settings = new \ArrayObject($settings, \ArrayObject::ARRAY_AS_PROPS);
        $this->settings->set($row['guild'], $settings);
        
        try {
            $this->setupGuild($row['guild']);
        } catch (\InvalidArgumentException $e) {
            $this->settings->delete($row['guild']);
            $this->runQuery('DELETE FROM `settings` WHERE `guild` = ?', array($row['guild']))->done(null, array($this->client, 'handlePromiseRejection'));
        }
    }
}