Slackbot::getCommandByMessage() - Code Metrics - Inspection of "Fix long line" - iranianpep/botonomous - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 00c1fd...903616 )

by Ehsan

created 2017-05-31 05:33 UTC

Slackbot::getCommandByMessage() B

↳ Parent: Slackbot

Complexity

Conditions	8
Paths	20

Size

Total Lines	54
Code Lines	23

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	21
CRAP Score	8.0421

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	54
ccs	21
cts	23
cp	0.913
rs	7.4119
cc	8
eloc	23
nc	20
nop	1
crap	8.0421

How to fix Long Method

<?php

namespace Botonomous;

use Botonomous\listener\EventListener;
use Botonomous\plugin\AbstractPlugin;

/**
 * Class Botonomous.
 */
class Slackbot extends AbstractBot
{
    private $commands;
    private $lastError;
    private $currentCommand;

    /**
     * Botonomous constructor.
     *
     * @param Config|null $config
     *
     * @throws \Exception
     */
    public function __construct(Config $config = null)
    {
        if ($config !== null) {
            $this->setConfig($config);
        }

        $this->setTimezone();
    }

    /**
     * Set the timezone.
     */
    private function setTimezone()
    {
        // set timezone
        date_default_timezone_set($this->getConfig()->get('timezone'));
    }

    /**
     * @param null|string $key
     *
     * @return mixed
     */
    public function getRequest($key = null)
    {
        return $this->getListener()->getRequest($key);
    }

    /**
     * @return null|AbstractBaseSlack
     */
    private function handleMessageActions()
    {
        $post = $this->getRequestUtility()->getPost();

        // ignore if payload is not set
        if (!isset($post['payload'])) {
            /* @noinspection PhpInconsistentReturnPointsInspection */
            return;
        }

        // posted payload is in JSON
        $payload = json_decode($post['payload'], true);

        return (new MessageAction())->load($payload);
    }

    /**
     * @throws \Exception
     */
    private function handleSendResponse()
    {
        // 1. Start listening
        $this->getListener()->listen();

        // 2. verify the request
        try {
            $verificationResult = $this->getListener()->verifyRequest();

            if ($verificationResult['success'] !== true) {
                throw new \Exception($verificationResult['message']);
            }
        } catch (\Exception $e) {
            throw $e;
        }

        // 3. pre process the request
        $this->preProcessRequest();

        // 4. check access control
        if ($this->checkAccessControl() !== true) {
            return;
        }

        // 5. set the current command
        $message = $this->getListener()->getMessage();
        $this->setCurrentCommand($this->getMessageUtility()->extractCommandName($message));

        // 6. log the message
        if (empty($this->getRequest('debug'))) {
            $this->getLoggerUtility()->logRaw($this->getFormattingUtility()->newLine());
            $this->getLoggerUtility()->logChat(__METHOD__, $message);
        }

        $this->getLoggerUtility()->logRaw($this->getRequestUtility()->getContent());

        // 7. send confirmation message if is enabled
        $this->getSender()->sendConfirmation();

        // 8. And send the response to the channel, only if the response is not empty
        $response = $this->respond($message);

        if (!empty($response)) {
            $this->getSender()->send($response);
        }
    }

    /**
     * @return bool
     */
    private function checkAccessControl()
    {
        // if accessControlEnabled is not set true ignore the check and return true
        if ($this->getConfig()->get('accessControlEnabled') !== true) {
            return true;
        }

        if ($this->getBlackList()->isBlackListed() !== false) {
            // found in blacklist
            $this->getSender()->send($this->getDictionary()->get('generic-messages')['blacklistedMessage']);

            return false;
        }

        if ($this->getWhiteList()->isWhiteListed() !== true) {
            // not found in whitelist
            $this->getSender()->send($this->getDictionary()->get('generic-messages')['whitelistedMessage']);

            return false;
        }

        return true;
    }

    /**
     * @throws \Exception
     */
    public function run()
    {
        switch ($this->getListener()->determineAction()) {
            case 'oauth':
                return $this->handleOAuth();
            case 'message_actions':
                return $this->handleMessageActions();
            case 'url_verification':
                return $this->handleUrlVerification();
            default:
                return $this->handleSendResponse();
        }
    }

    /**
     * handle OAuth.
     */
    private function handleOAuth()
    {
        return $this->getOauth()->doOauth();
    }

    /**
     * @throws \Exception
     *
     * @return mixed
     */
    private function handleUrlVerification()
    {
        $request = $this->getRequestUtility()->getPostedBody();

        if (empty($request['challenge'])) {
            throw new \Exception('Challenge is missing for URL verification');
        }

        echo $request['challenge'];
    }

    /**
     * Pre-process the request.
     */
    private function preProcessRequest()
    {
        $request = $this->getListener()->getRequest();

        // remove the trigger_word from beginning of the message
        if (!empty($request['trigger_word'])) {
            $request['text'] = $this->getMessageUtility()->removeTriggerWord(
                $request['text'],
                $request['trigger_word']
            );

            $this->getListener()->setRequest($request);
        }
    }

    /**
     * @param null $message
     *
     * @throws \Exception
     *
     * @return mixed
     */
    public function respond($message = null)
    {
        try {
            $command = $this->getCommandByMessage($message);

            if (!$command instanceof Command) {
                // something went wrong, error will tell us!
                return $this->getLastError();
            }

            // create the class
            $pluginClassFile = $command->getClass();
            $pluginClass = new $pluginClassFile($this);

            // check class is valid
            if (!$pluginClass instanceof AbstractPlugin) {
                throw new \Exception("Couldn't create class: '{$pluginClassFile}'");
            }

            // check action exists
            $action = $command->getAction();
            if (!method_exists($pluginClass, $action)) {
                throw new \Exception("Action / function: '{$action}' does not exist in '{$pluginClassFile}'");
            }

            return $pluginClass->$action();
        } catch (\Exception $e) {
            throw $e;
        }
    }

    /**
     * @param null $message
     *
     * @throws \Exception
     *
     * @return bool|Command
     */
    public function getCommandByMessage($message = null)
    {
        // If message is not set, get it from the current request
        if ($message === null) {
            $message = $this->getListener()->getMessage();
        }

        if (empty($message)) {
            $this->setLastError('Message is empty');

            return false;
        }

        /**
         * Process the message.
         */
        $command = $this->getMessageUtility()->extractCommandName($message);

        $config = $this->getConfig();

        // check command name
        if (empty($command)) {
            // get the default command if no command is find in the message
            $command = $config->get('defaultCommand');

            if (empty($command)) {
                $this->setLastError($this->getDictionary()->get('generic-messages')['noCommandMessage']);

                return false;
            }
        }

        $commandObject = $this->getCommandContainer()->getAsObject($command);

        // check command details
        if (empty($commandObject)) {
            $this->setLastError($this->getDictionary()->getValueByKey(
                'generic-messages', 'unknownCommandMessage', ['command' => $command])
            );

            return false;
        }

        if (!$commandObject instanceof Command) {
            throw new \Exception('Command is not an object');
        }

        // check the plugin for the command
        if (empty($commandObject->getPlugin())) {
            throw new \Exception('Plugin is not set for this command');
        }

        return $commandObject;
    }

    /**
     * @return array
     */
    public function getCommands()
    {
        if (!isset($this->commands)) {
            $this->setCommands($this->getCommandContainer()->getAllAsObject());
        }

        return $this->commands;
    }

    /**
     * @param array $commands
     */
    public function setCommands(array $commands)
    {
        $this->commands = $commands;
    }

    /**
     * @return string
     */
    public function getLastError()
    {
        return $this->lastError;
    }

    /**
     * @param string $lastError
     */
    public function setLastError($lastError)
    {
        $this->lastError = $lastError;
    }

    /**
     * @return string
     */
    public function getCurrentCommand()
    {
        return $this->currentCommand;
    }

    /**
     * @param string $currentCommand
     */
    public function setCurrentCommand($currentCommand)
    {
        $this->currentCommand = $currentCommand;
    }

    /**
     * Determine if bot user id is mentioned in the message.
     *
     * @return bool
     */
    public function youTalkingToMe()
    {
        $message = $this->getListener()->getMessage();

        if (empty($message)) {
            return false;
        }

        if ($this->getMessageUtility()->isBotMentioned($message) === true) {
            return true;
        }

        $listener = $this->getListener();
        // check direct messages
        return $listener instanceof EventListener && $listener->getEvent()->isDirectMessage() === true;
    }
}


1		<?php
2
3		namespace Botonomous;
4
5		use Botonomous\listener\EventListener;
6		use Botonomous\plugin\AbstractPlugin;
7
8		/**
9		* Class Botonomous.
10		*/
11		class Slackbot extends AbstractBot
12		{
13		private $commands;
14		private $lastError;
15		private $currentCommand;
16
17		/**
18		* Botonomous constructor.
19		*
20		* @param Config\|null $config
21		*
22		* @throws \Exception
23		*/
24	41	public function __construct(Config $config = null)
25		{
26	41	if ($config !== null) {
27	6	$this->setConfig($config);
28		}
29
30	41	$this->setTimezone();
31	41	}
32
33		/**
34		* Set the timezone.
35		*/
36	41	private function setTimezone()
37		{
38		// set timezone
39	41	date_default_timezone_set($this->getConfig()->get('timezone'));
40	41	}
41
42		/**
43		* @param null\|string $key
44		*
45		* @return mixed
46		*/
47	10	public function getRequest($key = null)
48		{
49	10	return $this->getListener()->getRequest($key);
50		}
51
52		/**
53		* @return null\|AbstractBaseSlack
54		*/
55	1	private function handleMessageActions()
56		{
57	1	$post = $this->getRequestUtility()->getPost();
58
59		// ignore if payload is not set
60	1	if (!isset($post['payload'])) {
61		/* @noinspection PhpInconsistentReturnPointsInspection */
62	1	return;
63		}
64
65		// posted payload is in JSON
66	1	$payload = json_decode($post['payload'], true);
67
68	1	return (new MessageAction())->load($payload);
69		}
70
71		/**
72		* @throws \Exception
73		*/
74	4	private function handleSendResponse()
75		{
76		// 1. Start listening
77	4	$this->getListener()->listen();
78
79		// 2. verify the request
80		try {
81	4	$verificationResult = $this->getListener()->verifyRequest();
82
83	4	if ($verificationResult['success'] !== true) {
84	4	throw new \Exception($verificationResult['message']);
85		}
86	1	} catch (\Exception $e) {
87	1	throw $e;
88		}
89
90		// 3. pre process the request
91	3	$this->preProcessRequest();
92
93		// 4. check access control
94	3	if ($this->checkAccessControl() !== true) {
95	2	return;
96		}
97
98		// 5. set the current command
99	1	$message = $this->getListener()->getMessage();
100	1	$this->setCurrentCommand($this->getMessageUtility()->extractCommandName($message));
101
102		// 6. log the message
103	1	if (empty($this->getRequest('debug'))) {
104		$this->getLoggerUtility()->logRaw($this->getFormattingUtility()->newLine());
105		$this->getLoggerUtility()->logChat(__METHOD__, $message);
106		}
107
108	1	$this->getLoggerUtility()->logRaw($this->getRequestUtility()->getContent());
109
110		// 7. send confirmation message if is enabled
111	1	$this->getSender()->sendConfirmation();
112
113		// 8. And send the response to the channel, only if the response is not empty
114	1	$response = $this->respond($message);
115
116	1	if (!empty($response)) {
117	1	$this->getSender()->send($response);
118		}
119	1	}
120
121		/**
122		* @return bool
123		*/
124	3	private function checkAccessControl()
125		{
126		// if accessControlEnabled is not set true ignore the check and return true
127	3	if ($this->getConfig()->get('accessControlEnabled') !== true) {
128	1	return true;
129		}
130
131	2	if ($this->getBlackList()->isBlackListed() !== false) {
132		// found in blacklist
133	1	$this->getSender()->send($this->getDictionary()->get('generic-messages')['blacklistedMessage']);
134
135	1	return false;
136		}
137
138	1	if ($this->getWhiteList()->isWhiteListed() !== true) {
139		// not found in whitelist
140	1	$this->getSender()->send($this->getDictionary()->get('generic-messages')['whitelistedMessage']);
141
142	1	return false;
143		}
144
145		return true;
146		}
147
148		/**
149		* @throws \Exception
150		*/
151	7	public function run()
152		{
153	7	switch ($this->getListener()->determineAction()) {
154	7	case 'oauth':
155	1	return $this->handleOAuth();
156	6	case 'message_actions':
157	1	return $this->handleMessageActions();
158	5	case 'url_verification':
159	1	return $this->handleUrlVerification();
160		default:
161	4	return $this->handleSendResponse();
162		}
163		}
164
165		/**
166		* handle OAuth.
167		*/
168	1	private function handleOAuth()
169		{
170	1	return $this->getOauth()->doOauth();
171		}
172
173		/**
174		* @throws \Exception
175		*
176		* @return mixed
177		*/
178	1	private function handleUrlVerification()
179		{
180	1	$request = $this->getRequestUtility()->getPostedBody();
181
182	1	if (empty($request['challenge'])) {
183		throw new \Exception('Challenge is missing for URL verification');
184		}
185
186	1	echo $request['challenge'];
187	1	}
188
189		/**
190		* Pre-process the request.
191		*/
192	3	private function preProcessRequest()
193		{
194	3	$request = $this->getListener()->getRequest();
195
196		// remove the trigger_word from beginning of the message
197	3	if (!empty($request['trigger_word'])) {
198	3	$request['text'] = $this->getMessageUtility()->removeTriggerWord(
199	3	$request['text'],
200	3	$request['trigger_word']
201		);
202
203	3	$this->getListener()->setRequest($request);
204		}
205	3	}
206
207		/**
208		* @param null $message
209		*
210		* @throws \Exception
211		*
212		* @return mixed
213		*/
214	4	public function respond($message = null)
215		{
216		try {
217	4	$command = $this->getCommandByMessage($message);
218
219	4	if (!$command instanceof Command) {
220		// something went wrong, error will tell us!
221	2	return $this->getLastError();
222		}
223
224		// create the class
225	3	$pluginClassFile = $command->getClass();
226	3	$pluginClass = new $pluginClassFile($this);
227
228		// check class is valid
229	3	if (!$pluginClass instanceof AbstractPlugin) {
230		throw new \Exception("Couldn't create class: '{$pluginClassFile}'");
231		}
232
233		// check action exists
234	3	$action = $command->getAction();
235	3	if (!method_exists($pluginClass, $action)) {
236	1	throw new \Exception("Action / function: '{$action}' does not exist in '{$pluginClassFile}'");
237		}
238
239	2	return $pluginClass->$action();
240	1	} catch (\Exception $e) {
241	1	throw $e;
242		}
243		}
244
245		/**
246		* @param null $message
247		*
248		* @throws \Exception
249		*
250		* @return bool\|Command
251		*/
252	7	public function getCommandByMessage($message = null)
253		{
254		// If message is not set, get it from the current request
255	7	if ($message === null) {
256	4	$message = $this->getListener()->getMessage();
257		}
258
259	7	if (empty($message)) {
260	1	$this->setLastError('Message is empty');
261
262	1	return false;
263		}
264
265		/**
266		* Process the message.
267		*/
268	6	$command = $this->getMessageUtility()->extractCommandName($message);
269
270	6	$config = $this->getConfig();
271
272		// check command name
273	6	if (empty($command)) {
274		// get the default command if no command is find in the message
275	2	$command = $config->get('defaultCommand');
276
277	2	if (empty($command)) {
278	2	$this->setLastError($this->getDictionary()->get('generic-messages')['noCommandMessage']);
279
280	2	return false;
281		}
282		}
283
284	4	$commandObject = $this->getCommandContainer()->getAsObject($command);
285
286		// check command details
287	4	if (empty($commandObject)) {
288	1	$this->setLastError($this->getDictionary()->getValueByKey(
289	1	'generic-messages', 'unknownCommandMessage', ['command' => $command])
290		);
291
292	1	return false;
293		}
294
295	4	if (!$commandObject instanceof Command) {
296		throw new \Exception('Command is not an object');
297		}
298
299		// check the plugin for the command
300	4	if (empty($commandObject->getPlugin())) {
301		throw new \Exception('Plugin is not set for this command');
302		}
303
304	4	return $commandObject;
305		}
306
307		/**
308		* @return array
309		*/
310	2	public function getCommands()
311		{
312	2	if (!isset($this->commands)) {
313	1	$this->setCommands($this->getCommandContainer()->getAllAsObject());
314		}
315
316	2	return $this->commands;
317		}
318
319		/**
320		* @param array $commands
321		*/
322	2	public function setCommands(array $commands)
323		{
324	2	$this->commands = $commands;
325	2	}
326
327		/**
328		* @return string
329		*/
330	4	public function getLastError()
331		{
332	4	return $this->lastError;
333		}
334
335		/**
336		* @param string $lastError
337		*/
338	4	public function setLastError($lastError)
339		{
340	4	$this->lastError = $lastError;
341	4	}
342
343		/**
344		* @return string
345		*/
346	1	public function getCurrentCommand()
347		{
348	1	return $this->currentCommand;
349		}
350
351		/**
352		* @param string $currentCommand
353		*/
354	2	public function setCurrentCommand($currentCommand)
355		{
356	2	$this->currentCommand = $currentCommand;
357	2	}
358
359		/**
360		* Determine if bot user id is mentioned in the message.
361		*
362		* @return bool
363		*/
364	1	public function youTalkingToMe()
365		{
366	1	$message = $this->getListener()->getMessage();
367
368	1	if (empty($message)) {
369	1	return false;
370		}
371
372	1	if ($this->getMessageUtility()->isBotMentioned($message) === true) {
373	1	return true;
374		}
375
376	1	$listener = $this->getListener();
377		// check direct messages
378	1	return $listener instanceof EventListener && $listener->getEvent()->isDirectMessage() === true;
379		}
380		}
381

iranianpep / botonomous

Push — master ( 00c1fd...903616 )

Slackbot::getCommandByMessage() B

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like