Add /wiki sample command

Signed-off-by: Joas Schilling <[email protected]>

appinfo/info.xml

@@ -63,6 +63,7 @@ And in the works for the [coming versions](https://github.com/nextcloud/spreed/m
 
 	<commands>
 		<command>OCA\Spreed\Command\Command\Add</command>
+		<command>OCA\Spreed\Command\Command\AddSamples</command>
 		<command>OCA\Spreed\Command\Command\Delete</command>
 		<command>OCA\Spreed\Command\Command\ListCommand</command>
 		<command>OCA\Spreed\Command\Command\Update</command>

lib/Command/Command/AddSamples.php

@@ -0,0 +1,76 @@
+<?php
+declare(strict_types=1);
+/**
+ * @copyright Copyright (c) 2019 Joas Schilling <[email protected]>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCA\Spreed\Command\Command;
+
+use OCA\Spreed\Model\Command;
+use OCA\Spreed\Service\CommandService;
+use OC\Core\Command\Base;
+use OCP\App\AppPathNotFoundException;
+use OCP\App\IAppManager;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class AddSamples extends Base {
+
+	use TRenderCommand;
+
+	/** @var CommandService */
+	private $service;
+	/** @var IAppManager */
+	protected $appManager;
+
+	public function __construct(CommandService $service, IAppManager $appManager) {
+		parent::__construct();
+		$this->service = $service;
+		$this->appManager = $appManager;
+	}
+
+	protected function configure(): void {
+		$this
+			->setName('talk:command:add-samples')
+			->setDescription('Adds some sample commands: /wiki, …')
+		;
+	}
+
+	protected function execute(InputInterface $input, OutputInterface $output) {
+		$commands = [];
+		try {
+			$commands[] = $this->service->create(
+				'',
+				'wiki',
+				'Wikipedia',
+				'php ' . $this->appManager->getAppPath('spreed') . '/sample-commands/wikipedia.php "{ARGUMENTS_DOUBLEQUOTE_ESCAPED}"',
+				Command::RESPONSE_ALL,
+				Command::ENABLED_ALL
+			);
+		} catch (AppPathNotFoundException $e) {
+			$output->writeln('<error>Could not determine the spreed/ app directory.</error>');
+			return 1;
+		}
+
+
+		$output->writeln('<info>Commands added</info>');
+		$output->writeln('');
+		$this->renderCommands(Base::OUTPUT_FORMAT_PLAIN, $output, $commands);
+	}
+}

lib/Migration/RegisterSampleCommands.php

@@ -0,0 +1,65 @@
+<?php
+declare(strict_types=1);
+/**
+ * @copyright Copyright (c) 2019, Joas Schilling <[email protected]>
+ *
+ * @author Joas Schilling <[email protected]>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCA\Spreed\Migration;
+
+use OCA\Spreed\Model\Command;
+use OCA\Spreed\Service\CommandService;
+use OCP\App\IAppManager;
+use OCP\AppFramework\Db\DoesNotExistException;
+use OCP\Migration\IOutput;
+use OCP\Migration\IRepairStep;
+
+class RegisterSampleCommands implements IRepairStep {
+
+	/** @var CommandService */
+	protected $service;
+	/** @var IAppManager */
+	protected $appManager;
+
+	public function __construct(CommandService $service, IAppManager $appManager) {
+		$this->service = $service;
+		$this->appManager = $appManager;
+	}
+
+	public function getName(): string {
+		return 'Create help command';
+	}
+
+	public function run(IOutput $output): void {
+		try {
+			$this->service->find('', 'wiki');
+		} catch (DoesNotExistException $e) {
+
+			$this->service->create(
+				'',
+				'wiki',
+				'Wikipedia search',
+				'php ' . $this->appManager->getAppPath('spreed') . '/sample-commands/wikipedia.php "{ARGUMENTS_DOUBLEQUOTE_ESCAPED}"',
+				Command::RESPONSE_ALL,
+				Command::ENABLED_ALL
+			);
+		}
+	}
+}

sample-commands/wikipedia.php

@@ -0,0 +1,88 @@
+<?php
+declare(strict_types=1);
+/**
+ * @copyright Copyright (c) 2019 Joas Schilling <[email protected]>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+if (PHP_SAPI !== 'cli') {
+	// Only allow access via the console
+	exit;
+}
+
+if ($argc < 2) {
+	echo 'Missing search term in call to wikipedia.php';
+	return 1;
+}
+
+$searchTerm = $argv[1];
+
+if ($searchTerm === '--help') {
+	echo '/wiki - A simple command to find wikipedia articles for a term' . "\n";
+	echo "\n";
+	echo 'Example: /wiki Nextcloud' . "\n";
+	$searchTerm = 'Nextcloud';
+}
+
+
+$endpoint = 'https://en.wikipedia.org/w/api.php';
+$parameters = [
+	'action' => 'opensearch',
+	'format' => 'json',
+	'formatversion' => 2,
+	'search' => $searchTerm,
+];
+$content = file_get_contents($endpoint . '?' . http_build_query($parameters));
+$results = json_decode($content, true);
+[, $titles, $descriptions, $links] = $results;
+
+$numArticles = count($titles);
+if ($numArticles === 0) {
+	echo 'Wikipedia did not have any results for "' . $searchTerm . '" :(' . "\n";
+	return;
+}
+
+if ($numArticles !== count($descriptions) || $numArticles !== count($links)) {
+	echo 'Result returned from wikipedia is maleformed';
+	return 1;
+}
+
+$response = 'Wikipedia search results for "' . $searchTerm . '":' . "\n";
+
+$maxArticles = $numArticles > 7 ? 5 : $numArticles;
+$length = (int) ((800 - strlen($response)) / $maxArticles);
+
+foreach ($titles as $key => $title) {
+	if ($key >= $maxArticles) {
+		break;
+	}
+
+	$link = " - {$links[$key]}\n";
+	$remainingLength = max(strlen($title),$length - strlen($link));
+	if ($remainingLength < strlen("* $title - {$descriptions[$key]}")) {
+		$response .= substr("* $title - {$descriptions[$key]}", 0, $remainingLength) . '…' . $link;
+	} else {
+		$response .= "* $title - {$descriptions[$key]}" . $link;
+	}
+}
+
+if ($maxArticles < $numArticles) {
+	$response .= '* and ' . ($numArticles - $maxArticles) ." more articles found\n";
+}
+
+echo ($response);