johnnymast / rivescript-php

src/Console/ChatCommand.php

<?php
/*
 * This file is part of Rivescript-php
 *
 * (c) Shea Lewis <shea.lewis89@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Axiom\Rivescript\Console;

use Axiom\Rivescript\Exceptions\ParseException;
use Axiom\Rivescript\Rivescript;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Question\Question;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

/**
 * ChatCommand class
 *
 * This class handles input from the interactive console from
 * the command-line.
 *
 * PHP version 7.4 and higher.
 *
 * @category Core
 * @package  Contracts
 * @author   Shea Lewis <shea.lewis89@gmail.com>
 * @license  https://opensource.org/licenses/MIT MIT
 * @link     https://github.com/axiom-labs/rivescript-php
 * @since    0.3.0
 */
class ChatCommand extends Command
{
    /**
     * @var Rivescript
     */
    protected Rivescript $rivescript;

    /**
     * Create a new ChatCommand instance.
     *
     * @param Rivescript $rivescript The Rivescript client.
     */
    public function __construct(Rivescript $rivescript)
    {
        $this->rivescript = $rivescript;

        parent::__construct();
    }

    /**
     * Configure the console command.
     *
     * @return void
     */
    public function configure(): void
    {
        $this->setName('chat')
            ->setDescription('Chat with a Rivescript instance')
            ->addArgument('source', InputArgument::REQUIRED, 'Your Rivescript source file');
    }

    /**
     * Execute the console command.
     *
     * @param InputInterface  $input  The input interface the message came from.
     * @param OutputInterface $output The output interface to output the response to.
     *
     * @return int
     */
    public function execute(InputInterface $input, OutputInterface $output): int
    {
        try {
            $this->rivescript->onSay = function (string $msg, int $verbosity) use ($output) {
                $output->writeln("Say: {$msg}", $verbosity);
            };


            $source = $this->loadFiles($input->getArgument('source'));

            $this->rivescript->load($source);

            $loadedSource = explode('/', $input->getArgument('source'));
            $loadedSource = end($loadedSource);

            $output->writeln('RiveScript Interpreter (PHP) -- Interactive Console v2.0');
            $output->writeln('--------------------------------------------------------');
            $output->writeln('RiveScript Version:       2.0');
            $output->writeln('Currently Loaded Source:  ' . $loadedSource);
            $output->writeln('');
            $output->writeln('You are now chatting with a RiveScript bot. Type a message and press Return');
            $output->writeln('to send it. When finished, type "/quit" to exit the interactive console.');
            $output->writeln('');

            $this->waitForUserInput($input, $output);
        } catch (ParseException $e) {
            $error = "<error>{$e->getMessage()}</error>";
            $output->writeln($error);

            log_warning($e->getMessage());
        }

        return 0;
    }

    /**
     * Wait and listen for user input.
     *
     * @param InputInterface  $input  The input interface the message came from.
     * @param OutputInterface $output The output interface to output the response to.
     *
     * @return void
     */
    protected function waitForUserInput(InputInterface $input, OutputInterface $output): void
    {
        $helper = $this->getHelper('question');
        $question = new Question('<info>You > </info>');

        $message = $helper->ask($input, $output, $question);

        $this->listenForConsoleCommands($input, $output, $message);

        $this->getBotResponse($input, $output, $message);
    }

    /**
     * Listen for console commands before passing message to interpreter.
     *
     * @param InputInterface  $input   The input interface the message came from.
     * @param OutputInterface $output  The output interface to output the response to.
     * @param string          $message The message typed in the console.
     *
     * @return int
     */
    protected function listenForConsoleCommands(InputInterface $input, OutputInterface $output, string $message): int
    {
        if ($message === '/quit') {
            $output->writeln('Exiting...');
            die();

Using exit here is not recommended.

In this branch, the function will implicitly return null which is incompatible with the type-hinted return integer. Consider adding a return statement or allowing null as return value.

        }

        if ($message === '/reload') {
            return $this->execute($input, $output);
        }

        if ($message === '/help') {
            $output->writeln('');
            $output->writeln('<comment>Usage:</comment>');
            $output->writeln('  Type a message and press Return to send.');
            $output->writeln('');
            $output->writeln('<comment>Commands:</comment>');
            $output->writeln('  <info>/help</info>        Show this text');
            $output->writeln('  <info>/reload</info>      Reload the interactive console');
            $output->writeln('  <info>/quit</info>        Quit the interative console');
            $output->writeln('');

            $this->waitForUserInput($input, $output);
        }

        return 0;
    }

    /**
     * Pass along user message to interpreter and fetch a reply.
     *
     * @param InputInterface  $input   The input interface the message came from.
     * @param OutputInterface $output  The output interface to output the response to.
     * @param string          $message The message typed in the console.
     *
     * @return void
     */
    protected function getBotResponse(InputInterface $input, OutputInterface $output, string $message): void
    {
        $bot = 'Bot > ';
        $reply = $this->rivescript->reply($message);
        $response = "<info>{$reply}</info>";

        $output->writeln($bot . $response);

        $this->waitForUserInput($input, $output);
    }

    /**
     * Load and return an array of files.
     *
     * @param string $info One file or directory of rivescript files.
     *
     * @return array<string>
     */
    private function loadFiles(string $info): array
    {
        if (is_dir($info)) {
            $directory = realpath($info);
            $files = [];
            $brains = glob($directory . '/*.rive');

            foreach ($brains as $brain) {
                $files[] = $brain;
            }

            return $files;
        }

        return (array)$info;
    }
}