diff options
author | Joas Schilling <coding@schilljs.com> | 2019-04-02 17:35:45 +0300 |
---|---|---|
committer | Joas Schilling <coding@schilljs.com> | 2019-04-08 18:00:53 +0300 |
commit | d3835dfc83c936e0cabe99052fa558614bf5764c (patch) | |
tree | cb7f50456b250d11df4dd03cdffcb4e9650784ac | |
parent | 7316ba61479591dd67220f62bf8ba0b9a671b060 (diff) |
Add /wiki sample command
Signed-off-by: Joas Schilling <coding@schilljs.com>
-rw-r--r-- | appinfo/info.xml | 1 | ||||
-rw-r--r-- | lib/Command/Command/AddSamples.php | 76 | ||||
-rw-r--r-- | lib/Migration/RegisterSampleCommands.php | 65 | ||||
-rw-r--r-- | sample-commands/wikipedia.php | 88 |
4 files changed, 230 insertions, 0 deletions
diff --git a/appinfo/info.xml b/appinfo/info.xml index 5b59ad396..439178490 100644 --- a/appinfo/info.xml +++ b/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> diff --git a/lib/Command/Command/AddSamples.php b/lib/Command/Command/AddSamples.php new file mode 100644 index 000000000..9016a5be2 --- /dev/null +++ b/lib/Command/Command/AddSamples.php @@ -0,0 +1,76 @@ +<?php +declare(strict_types=1); +/** + * @copyright Copyright (c) 2019 Joas Schilling <coding@schilljs.com> + * + * @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); + } +} diff --git a/lib/Migration/RegisterSampleCommands.php b/lib/Migration/RegisterSampleCommands.php new file mode 100644 index 000000000..c20fc8f18 --- /dev/null +++ b/lib/Migration/RegisterSampleCommands.php @@ -0,0 +1,65 @@ +<?php +declare(strict_types=1); +/** + * @copyright Copyright (c) 2019, Joas Schilling <coding@schilljs.com> + * + * @author Joas Schilling <coding@schilljs.com> + * + * @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 + ); + } + } +} diff --git a/sample-commands/wikipedia.php b/sample-commands/wikipedia.php new file mode 100644 index 000000000..1fcccf1e3 --- /dev/null +++ b/sample-commands/wikipedia.php @@ -0,0 +1,88 @@ +<?php +declare(strict_types=1); +/** + * @copyright Copyright (c) 2019 Joas Schilling <coding@schilljs.com> + * + * @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); |