Context::setResponses() - Code Metrics - Inspection of "Rename CommandMessage to Commands\Context (#21)" - CharlotteDunois/Livia - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( f4586f...06e79d )

by Charlotte
created 2019-04-05 11:37 UTC
Context::setResponses() A

↳ Parent: Context
Complexity

Conditions	1
Paths	1
Size

Total Lines	2
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	1
nc	1
nop	1
dl	0
loc	2
rs	10
c	0
b	0
f	0
<?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\Commands;

/**
 * Represents a command invocation context.
 *
 * @property \CharlotteDunois\Livia\LiviaClient            $client          The client which initiated the instance.
 * @property \CharlotteDunois\Yasmin\Models\Message        $message         The message that triggers the command.
 * @property \CharlotteDunois\Livia\Commands\Command|null  $command         The command that got triggered, if any.
 *
 * @property string|null                                   $argString       Argument string for the command.
 * @property string[]|null                                 $patternMatches  Pattern matches (if from a pattern trigger).
 */
class Context extends \CharlotteDunois\Yasmin\Models\ClientBase {
    /**
     * The client which initiated the instance.
     * @var \CharlotteDunois\Livia\LiviaClient
     */
    protected $client;
    
    /**
     * The message that triggers the command.
     * @var \CharlotteDunois\Yasmin\Models\Message
     */
    protected $message;
    
    /**
     * The command that got triggered, if any.
     * @var \CharlotteDunois\Livia\Commands\Command|null
     */
    protected $command;
    
    /**
     * Argument string for the command.
     * @var string|null
     */
    protected $argString;
    
    /**
     * Pattern matches (if from a pattern trigger).
     * @var string[]|null
     */
    protected $patternMatches;
    
    /**
     * Command responses, as multidimensional array (channelID|dm => Message[]).
     * @var array
     */
    protected $responses = array();
    
    /**
     * Internal command for serialization.
     * @var string|null
     */
    protected $internalCommand;
    
    /**
     * @internal
     */
    function __construct(\CharlotteDunois\Livia\LiviaClient $client, \CharlotteDunois\Yasmin\Models\Message $message, \CharlotteDunois\Livia\Commands\Command $command = null, string $argString = null, array $patternMatches = null) {
        $this->client = $client;
        $this->message = $message;
        $this->command = $command;
        
        $this->argString = ($argString !== null ? \trim($argString) : null);
        $this->patternMatches = $patternMatches;
    }
    
    /**
     * @param string  $name
     * @return bool
     * @throws \Exception
     * @internal
     */
    function __isset($name) {
        try {
            return $this->$name !== null;
        } catch (\RuntimeException $e) {
            if($e->getTrace()[0]['function'] === '__get') {
                return false;
            }
            
            throw $e;
        }
    }
    
    /**
     * @param string  $name
     * @return mixed
     * @throws \RuntimeException
     * @internal
     */
    function __get($name) {
        if(\property_exists($this, $name)) {
            return $this->$name;
        }
        
        return $this->message->$name;
    }
    
    /**
     * @return mixed
     * @throws \RuntimeException
     * @internal
     */
    function __call($name, $args) {
        if(\method_exists($this->message, $name)) {
            return $this->message->$name(...$args);
        }
        
        throw new \RuntimeException('Unknown method '.\get_class($this).'::'.$name);
    }
    
    /**
     * @return string
     * @internal
     */
    function serialize() {
        $cmd = $this->command;
        $this->command = null;
        
        if($cmd !== null) {
            $this->internalCommand = $cmd->groupID.':'.$cmd->name;
        }
        
        $str = parent::serialize();
        $this->command = $cmd;
        
        return $str;
    }
    
    /**
     * @return void
     * @internal
     */
    function unserialize($data) {
        if(self::$serializeClient === null) {
            throw new \Exception('Unable to unserialize a class without ClientBase::$serializeClient being set');
        }
        
        parent::unserialize($data);
        
        /** @var \CharlotteDunois\Livia\LiviaClient  $this->client */
        $this->client = self::$serializeClient;
        
        if($this->internalCommand !== null) {
            $this->command = $this->client->registry->resolveCommand($this->internalCommand);
            $this->internalCommand = null;
        }
    }
    
    /**
     * Parses the argString into usable arguments, based on the argsType and argsCount of the command.
     * @return string|string[]
     * @throws \LogicException
     * @throws \RangeException
     */
    function parseCommandArgs() {
        if($this->command === null) {
            throw new \LogicException('This message has no command');
        }
        
        switch($this->command->argsType) {
            case 'single':
                $args = $this->argString;
                return \preg_replace(($this->command->argsSingleQuotes ? '/^("|\')(.*)\1$/u' : '/^(")(.*)"$/u'), '$2', $args);
            case 'multiple':
                return self::parseArgs($this->argString, $this->command->argsCount, $this->command->argsSingleQuotes);
            default:
                throw new \RangeException('Unknown argsType "'.$this->command->argsType.'".');
        }
    }
    
    /**
     * Runs the command. Resolves with an instance of Message or an array of Message instances.
     * @return \React\Promise\ExtendedPromiseInterface
     * @throws \LogicException
     */
    function run() {
        if($this->command === null) {
            throw new \LogicException('This message has no command');
        }
        
        return (new \React\Promise\Promise(function (callable $resolve, callable $reject) {
            $promises = array();
            
            // Obtain the member if we don't have it
            if($this->message->guild !== null && !$this->message->guild->members->has($this->message->author->id) && $this->message->webhookID === null) {
                $promises[] = $this->message->guild->fetchMember($this->message->author->id);
            }
            
            // Obtain the member for the client user if we don't have it
            if($this->message->guild !== null && $this->message->guild->me === null) {
                $promises[] = $this->message->guild->fetchMember($this->client->user->id);
            }
            
            if($this->command->guildOnly && $this->message->guild === null) {
                $this->client->emit('commandBlocked', $this, 'guildOnly');
                return $this->client->dispatcher->throttleNegativeResponseMessage($this, 'The `'.$this->command->name.'` command must be used in a server channel.', $resolve, $reject);
            }
            
            if($this->command->nsfw && !($this->message->channel->nsfw ?? true)) {
                $this->client->emit('commandBlocked', $this, 'nsfw');
                return $this->client->dispatcher->throttleNegativeResponseMessage($this, 'The `'.$this->command->name.'` command must be used in NSFW channels.', $resolve, $reject);
            }
            
            $perms = $this->command->hasPermission($this);
            if($perms === false || \is_string($perms)) {
                $this->client->emit('commandBlocked', $this, 'permission');
                
                if($this->patternMatches !== null && !((bool) $this->client->getOption('commandBlockedMessagePattern', true))) {
                    return $resolve();
                }
                
                if($perms === false) {
                    $perms = 'You do not have permission to use the `'.$this->command->name.'` command.';
                }
                
                return $this->client->dispatcher->throttleNegativeResponseMessage($this, $perms, $resolve, $reject);
            }
            
            // Ensure the client user has the required permissions
            if($this->message->channel->guild !== null && !empty($this->command->clientPermissions)) {
                $perms = $this->message->channel->permissionsFor($this->message->guild->me);
                
                $missing = array();
                foreach($this->command->clientPermissions as $perm) {
                    if($perms->missing($perm)) {
                        $missing[] = $perm;
                    }
                }
                
                if(\count($missing) > 0) {
                    $this->client->emit('commandBlocked', $this, 'clientPermissions');
                    
                    if($this->patternMatches !== null && !((bool) $this->client->getOption('commandBlockedMessagePattern', true))) {
                        return $resolve();
                    }
                    
                    if(\count($missing) === 1) {
                        $msg = 'I need the permissions `'.$missing[0].'` permission for the `'.$this->command->name.'` command to work.';
                    } else {
                        $missing = \implode(', ', \array_map(function ($perm) {
                            return '`'.\CharlotteDunois\Yasmin\Models\Permissions::resolveToName($perm).'`';
                        }, $missing));
                        $msg = 'I need the following permissions for the `'.$this->command->name.'` command to work:'.\PHP_EOL.$missing;
                    }
                    
                    return $this->client->dispatcher->throttleNegativeResponseMessage($this, $msg, $resolve, $reject);
                }
            }
            
            // Throttle the command
            $throttle = $this->command->throttle($this->message->author->id);
            if($throttle && ($throttle['usages'] + 1) > ($this->command->throttling['usages'])) {
                $remaining = $throttle['start'] + $this->command->throttling['duration'] - \time();
                $this->client->emit('commandBlocked', $this, 'throttling');
                
                if($this->patternMatches !== null && !((bool) $this->client->getOption('commandThrottlingMessagePattern', true))) {
                    return $resolve();
                }
                
                return $this->client->dispatcher->throttleNegativeResponseMessage(
                    $this,
                    'You may not use the `'.$this->command->name.'` command again for another '.$remaining.' seconds.',
                    $resolve,
                    $reject
                );
            }
            
            // Figure out the command arguments
            $args = $this->patternMatches;
            $argmsgs = array();
            $countArgs = \count($this->command->args);
            
            if(!$args && $countArgs > 0) {
                $count = (!empty($this->command->args[($countArgs - 1)]['infinite']) ? \INF : $countArgs);
                $provided = self::parseArgs($this->argString, $count, $this->command->argsSingleQuotes);
                
                $promises[] = $this->command->argsCollector->obtain($this, $provided)->then(function ($result) use (&$args, &$argmsgs) {
                    if($result['cancelled']) {
                        if(\count($result['prompts']) === 0) {
                            throw new \CharlotteDunois\Livia\Exceptions\CommandFormatException($this);
                        }
                        
                        $argmsgs = $result['prompts'];
                        $this->client->emit('commandCancelled', $this, $result['cancelled']);
                        
                        throw new \CharlotteDunois\Livia\Exceptions\FriendlyException('Cancelled Command.');
                    }
                    
                    $args = $result['values'];
                    $argmsgs = $result['prompts'];
                    
                    if(!$args) {
                        $args = $this->parseCommandArgs();
                    }
                    
                    $args = new \ArrayObject(((array) $args), \ArrayObject::ARRAY_AS_PROPS);
                });
            } else {
                $args = new \ArrayObject(((array) $args), \ArrayObject::ARRAY_AS_PROPS);
            }
            
            // Run the command
            if($throttle) {
                $this->command->updateThrottle($this->message->author->id);
            }
            
            $typingCount = $this->message->channel->typingCount();
            
            \React\Promise\all($promises)->then(function () use (&$args, &$argmsgs) {
                $promise = $this->command->run($this, $args, ($this->patternMatches !== null));
                
                if(!($promise instanceof \React\Promise\PromiseInterface)) {
                    $promise = \React\Promise\resolve($promise);
                }
                
                $this->client->emit('commandRun', $this->command, $promise, $this, $args, ($this->patternMatches !== null));
                
                return $promise->then(function ($response) use (&$argmsgs) {
                    if(!($response instanceof \CharlotteDunois\Yasmin\Models\Message || $response instanceof \CharlotteDunois\Collect\Collection || \is_array($response) || $response === null)) {
                        throw new \RuntimeException('Command '.$this->command->name.'\'s run() resolved with an unknown type ('.\gettype($response).'). Command run methods must return a Promise that resolve with a Message, an array of Messages, a Collection of Messages, or null.');
                    }
                    
                    if(!\is_array($response) && !($response instanceof \CharlotteDunois\Collect\Collection)) {
                        if($response instanceof \CharlotteDunois\Yasmin\Models\Message) {
                            $argmsgs[] = $response;
                        }
                        
                        return $argmsgs;
                    }
                    
                    foreach($response as &$val) {
                        if(!($val instanceof \React\Promise\PromiseInterface)) {
                            $val = \React\Promise\resolve($val);
                        }
                    }
                    
                    return \React\Promise\all($response)->then(function ($msgs) use (&$argmsgs) {
                        return \array_merge($argmsgs, $msgs);
                    });
                });
            })->otherwise(function ($error) use (&$args, $typingCount, &$argmsgs) {
                if($this->message->channel->typingCount() > $typingCount) {
                    $this->message->channel->stopTyping();
                }
                
                if($error instanceof \CharlotteDunois\Livia\Exceptions\FriendlyException) {
                    return $this->reply($error->getMessage())->then(function (\CharlotteDunois\Yasmin\Models\Message $msg) use (&$argmsgs) {
                        $argmsgs[] = $msg;
                        return $argmsgs;
                    });
                }
                
                $this->client->emit('commandError', $this->command, $error, $this, $args, ($this->patternMatches !== null));
                
                $owners = $this->client->owners;
                $ownersLength = \count($owners);
                
                if($ownersLength > 0) {
                    $index = 0;
                    $owners = \array_map(function ($user) use ($index, $ownersLength) {
                        $or = ($ownersLength > 1 && $index === ($ownersLength - 1) ? 'or ' : '');
                        $index++;
                        
                        return $or.\CharlotteDunois\Yasmin\Utils\MessageHelpers::escapeMarkdown($user->tag);
                    }, $owners);
                    
                    $owners = \implode((\count($owners) > 2 ? ', ' : ' '), $owners);
                } else {
                    $owners = 'the bot owner';
                }
                
                return $this->reply('An error occurred while running the command: `'.\get_class($error).': '.\str_replace('`', '', $error->getMessage()).'`'.\PHP_EOL.
                        'You shouldn\'t ever receive an error like this.'.\PHP_EOL.
                        'Please contact '.$owners.($this->client->getOption('invite') ? ' in this server: '.$this->client->getOption('invite') : '.'))
                        ->then(function (\CharlotteDunois\Yasmin\Models\Message $msg) use (&$argmsgs) {
                            $argmsgs[] = $msg;
                            return $argmsgs;
                        });
            })->done($resolve, $reject);
        }));
    }
    
    /**
     * Responds to the command message
     * @param string  $type      One of plain, reply or direct.
     * @param string  $content
     * @param array   $options
     * @param bool    $fromEdit
     * @return \React\Promise\ExtendedPromiseInterface
     * @throws \RangeException
     * @throws \InvalidArgumentException
     */
    protected function respond(string $type, string $content, array $options = array(), bool $fromEdit = false) {
        if($type === 'reply' && $this->message->channel instanceof \CharlotteDunois\Yasmin\Interfaces\DMChannelInterface) {
            $type = 'plain';
        }
        
        if($type !== 'direct' && $this->message->guild !== null && !$this->message->channel->permissionsFor($this->client->user)->has('SEND_MESSAGES')) {
            $type = 'direct';
        }
        
        if(!empty($options['split']) && !\is_array($options['split'])) {
            $options['split'] = array();
        }
        
        $channelID = $this->getChannelIDOrDM($this->message->channel);
        $shouldEdit = (
            !empty($this->responses) &&
            (
                ($type === 'direct' && !empty($this->responses['dm'])) ||
                ($type !== 'direct' && !empty($this->responses[$channelID]))
            ) &&
            !$fromEdit &&
            empty($options['files'])
        );
        
        switch($type) {
            case 'plain':
                if($shouldEdit) {
                    return $this->editCurrentResponse($channelID, $type, $content, $options);
                } else {
                    return $this->message->channel->send($content, $options);
                }
            break;
            case 'reply':
                if($shouldEdit) {
                    return $this->editCurrentResponse($channelID, $type, $content, $options);
                } else {
                    if(!empty($options['split']) && empty($options['split']['prepend'])) {
                        $options['split']['prepend'] = $this->message->author->__toString().\CharlotteDunois\Yasmin\Models\Message::$replySeparator;
                    }
                    
                    return $this->message->reply($content, $options);
                }
            break;
            case 'direct':
                if($shouldEdit) {
                    return $this->editCurrentResponse($channelID, $type, $content, $options);
                } else {
                    return $this->message->author->createDM()->then(function ($channel) use ($content, $options) {
                        return $channel->send($content, $options);
                    });
                }
            break;
            default:
                throw new \RangeException('Unknown response type "'.$type.'"');
            break;
        }
    }
    
    /**
     * Edits a response to the command message. Resolves with an instance of Message or an array of Message instances.
     * @param \CharlotteDunois\Yasmin\Models\Message|\CharlotteDunois\Yasmin\Models\Message[]|null  $response
     * @param string                                                                                $type
     * @param string                                                                                $content
     * @param array                                                                                 $options
     * @return \React\Promise\ExtendedPromiseInterface
     */
    protected function editResponse($response, string $type, string $content, array $options = array()) {
        if(!$response) {
            return $this->respond($type, $content, $options);
        }
        
        if(!empty($options['split'])) {
            $content = \CharlotteDunois\Yasmin\Utils\MessageHelpers::splitMessage($content, (\is_array($options['split']) ? $options['split'] : array()));
            if(\count($content) === 1) {
                $content = $content[0];
            }
        }
        
        $prepend = '';
        if($type === 'reply') {
            $prepend = $this->message->author->__toString().\CharlotteDunois\Yasmin\Models\Message::$replySeparator;
        }
        
        if(\is_array($content)) {
            $promises = array();
            $clength = \count($content);
            
            if(\is_array($response)) {
                for($i = 0;  $i < $clength; $i++) {
                    if(!empty($response[$i])) {
                        $promises[] = $response[$i]->edit($prepend.$content[$i], $options);
                    } else {
                        $promises[] = $this->message->channel->send($prepend.$content[$i], $options);
                    }
                }
            } else {
                $promises[] = $response->edit($prepend.$content[0], $options);
                for($i = 1; $i < $clength; $i++) {
                    $promises[] = $this->message->channel->send($prepend.$content[$i], $options);
                }
            }
            
            return \React\Promise\all($promises);
        } else {
            if(\is_array($response)) {
                for($i = \count($response) - 1;  $i > 0; $i--) {
                    $response[$i]->delete()->done();
                }
                
                return $response[0]->edit($prepend.$content, $options);
            } else {
                return $response->edit($prepend.$content, $options);
            }
        }
    }
    
    /**
     * Edits the current response.
     * @param string  $id       The ID of the channel the response is in ("DM" for direct messages).
     * @param string  $type
     * @param string  $content
     * @param array   $options
     * @return \React\Promise\ExtendedPromiseInterface
     */
    protected function editCurrentResponse(string $id, string $type, string $content, array $options = array()) {
        if(empty($this->responses[$id])) {
            $this->responses[$id] = array();
        }
        
        if(!empty($this->responses[$id])) {
            $msg = \array_shift($this->responses[$id]);
        } else {
            $msg = null;
        }
        
        return $this->editResponse($msg, $type, $content, $options);
    }
    
    /**
     * Responds with a plain message. Resolves with an instance of Message or an array of Message instances.
     * @param string  $content
     * @param array   $options  Message Options.
     * @return \React\Promise\ExtendedPromiseInterface
     */
    function say(string $content, array $options = array()) {
        return $this->respond('plain', $content, $options);
    }
    
    /**
     * Responds with a reply message. Resolves with an instance of Message or an array of Message instances.
     * @param string  $content
     * @param array   $options  Message Options.
     * @return \React\Promise\ExtendedPromiseInterface
     */
    function reply(string $content, array $options = array()) {
        return $this->respond('reply', $content, $options);
    }
    
    /**
     * Responds with a direct message. Resolves with an instance of Message or an array of Message instances.
     * @param string  $content
     * @param array   $options  Message Options.
     * @return \React\Promise\ExtendedPromiseInterface
     */
    function direct(string $content, array $options = array()) {
        return $this->respond('direct', $content, $options);
    }
    
    /**
     * Shortcut to $this->message->edit.
     * @param string  $content
     * @param array   $options  Message Options.
     * @return \React\Promise\ExtendedPromiseInterface
     */
    function edit(string $content, array $options = array()) {
        return $this->message->edit($content, $options);
    }
    
    /**
     * Finalizes the command message by setting the responses and deleting any remaining prior ones.
     * @param \CharlotteDunois\Yasmin\Models\Message|\CharlotteDunois\Yasmin\Models\Message[]|null  $responses
     * @return void
     * @internal
     */
    function finalize($responses) {
        if(!empty($this->responses)) {
            $this->deleteRemainingResponses();
        }
        
        if(\is_array($responses)) {
            foreach($responses as $response) {
                /** @var \CharlotteDunois\Yasmin\Models\Message  $msg */
                $msg = (\is_array($response) ? $response[0] : $response);
                
                if(!($msg instanceof \CharlotteDunois\Yasmin\Models\Message)) {
                    continue;
                }
                
                $id = $this->getChannelIDOrDM($msg->channel);
                
                if(empty($this->responses[$id])) {
                    $this->responses[$id] = array();
                }
                
                $this->responses[$id][] = $response;
            }
        } elseif($responses !== null) {
            if(!($responses instanceof \CharlotteDunois\Yasmin\Models\Message)) {
                return;
            }
            
            $id = $this->getChannelIDOrDM($responses->channel);
            $this->responses[$id] = array($responses);
        }
    }
    
    /**
     * Deletes any prior responses that haven't been updated.
     * @return void
     * @internal
     */
    function deleteRemainingResponses() {
        foreach($this->responses as $id => $msgs) {
            foreach($msgs as $response) {
                if(\is_array($response)) {
                    foreach($response as $resp) {
                        $resp->delete()->done();
                    }
                } else {
                    $response->delete()->done();
                }
            }
            
            $this->responses[$id] = array();
        }
    }
    
    /**
     * @return string|int
     */
    protected function getChannelIDOrDM(\CharlotteDunois\Yasmin\Interfaces\TextChannelInterface $channel) {
        if(!($channel instanceof \CharlotteDunois\Yasmin\Interfaces\DMChannelInterface)) {
            return $channel->id;
        }
        
        return 'dm';
    }
    
    /**
     * Parses an argument string into an array of arguments.
     * @param string          $argString
     * @param int|float|null  $argCount           float = \INF
     * @param bool            $allowSingleQuotes
     * @return string[]
     */
    static function parseArgs(string $argString, $argCount = null, bool $allowSingleQuotes = true) {
        if(\mb_strlen($argString) === 0) {
            return array();
        }
        
        if($argCount === 1) {
            return array($argString);
        }
        
        $regex = '/(?:(['.($allowSingleQuotes ? "'" : '').'"])(.*?)(?<!\\\\)(?>\\\\\\\)*\1|([^\\s]+))/Su';
        $results = array();
        
        $argString = \trim($argString);
        
        if($argCount === null) {
            $argCount = \mb_strlen($argString); // Large enough to get all items
        }
        
        $content = $argString;
        \preg_match_all($regex, $argString, $matches);
        
        foreach($matches[0] as $key => $val) {
            $argCount--;
            if($argCount === 0) {
                break;
            }
            
            $val = \trim(($matches[3][$key] !== '' ? $matches[3][$key] : ($matches[2][$key] !== '' ? $matches[2][$key] : $matches[1][$key])));
            $results[] = $val;
            
            $content = \trim(\preg_replace('/'.\preg_quote($val, '/').'/u', '', $content, 1));
        }
        
        // If text remains, push it to the array as-is (except for wrapping quotes, which are removed)
        if(\mb_strlen($content) > 0) {
            $results[] = \preg_replace(($allowSingleQuotes ? '/^("|\')(.*)\1$/u' : '/^(")(.*)\1$/u'), '$2', $content);
        }
        
        if(\count($results) > 0) {
            $results = \array_filter($results, function ($val) {
                return (\mb_strlen(\trim($val)) > 0);
            });
        }
        
        return $results;
    }
    
    /**
     * @return void
     * @internal
     */
    function setResponses($responses) {
        $this->responses = $responses;
    }
}

CharlotteDunois / Livia

Push — master ( f4586f...06e79d )

Context::setResponses() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
