Add CLI Commands

appinfo/info.xml

@@ -48,6 +48,12 @@
 		</post-migration>
 	</repair-steps>
 
+	<commands>
+		<command>OCA\AnnouncementCenter\Command\Announce</command>
+		<command>OCA\AnnouncementCenter\Command\AnnouncementList</command>
+		<command>OCA\AnnouncementCenter\Command\AnnouncementDelete</command>
+	</commands>
+
 	<settings>
 		<admin>OCA\AnnouncementCenter\Settings\Admin</admin>
 	</settings>

lib/Command/Announce.php

@@ -0,0 +1,200 @@
+<?php
+/**
+ * @copyright Copyright (c) 2024 Marvin Winkens <m.winkens@fz-juelich.de>
+ *
+ * @author Marvin Winkens <m.winkens@fz-juelich.de>
+ *
+ * @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\AnnouncementCenter\Command;
+
+use OCA\AnnouncementCenter\Manager;
+use OCA\AnnouncementCenter\Model\NotificationType;
+use OCP\AppFramework\Utility\ITimeFactory;
+use OCP\IUserManager;
+use Psr\Log\LoggerInterface;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class Announce extends Command {
+	protected IUserManager $userManager;
+	protected ITimeFactory $time;
+	protected Manager $manager;
+	protected NotificationType $notificationType;
+	protected LoggerInterface $logger;
+	public function __construct(IUserManager $userManager, ITimeFactory $time, Manager $manager, NotificationType $notificationType, LoggerInterface $logger) {
+		parent::__construct();
+		$this->userManager = $userManager;
+		$this->time = $time;
+		$this->manager = $manager;
+		$this->notificationType = $notificationType;
+		$this->logger = $logger;
+	}
+
+	protected function configure(): void {
+		$this
+			->setName('announcementcenter:announce')
+			->setDescription('Create an announcement')
+			->addArgument(
+				'user',
+				InputArgument::REQUIRED,
+				'User who creates the announcement',
+			)
+			->addArgument(
+				'subject',
+				InputArgument::REQUIRED,
+				'Subject of the announcement',
+			)
+			->addArgument(
+				'message',
+				InputArgument::REQUIRED,
+				'Message of the announcement (supports markdown)',
+			)
+			->addOption(
+				'activities',
+				null,
+				InputOption::VALUE_NONE,
+				'Generate activities',
+			)
+			->addOption(
+				'notifications',
+				null,
+				InputOption::VALUE_NONE,
+				'Generate notifications',
+			)
+			->addOption(
+				'emails',
+				null,
+				InputOption::VALUE_NONE,
+				'Notify users via email',
+			)
+			->addOption(
+				'comments',
+				null,
+				InputOption::VALUE_NONE,
+				'Allow comments',
+			)
+			->addOption(
+				'schedule-time',
+				's',
+				InputOption::VALUE_OPTIONAL,
+				'Publishing time of the announcement (see php strtotime)',
+				null,
+			)
+			->addOption(
+				'delete-time',
+				'd',
+				InputOption::VALUE_OPTIONAL,
+				'Deletion time of the announcement (see php strtotime)',
+				null,
+			)
+			->addOption(
+				'group',
+				'g',
+				InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY,
+				'Group to set send announcement to (default "everyone", multiple allowed)',
+				['everyone'],
+			);
+	}
+
+	private function plainifyMessage(string $message) {
+		# TODO use Parsedown or Markdownify here
+		return $message;
+	}
+
+	protected function execute(InputInterface $input, OutputInterface $output): int {
+		// required
+		$user = $input->getArgument('user');
+		if (!$this->userManager->userExists($user)) {
+			$output->writeln("User <$user> in unknown.");
+			return 1;
+		}
+		$subject = $input->getArgument('subject');
+		$message = $input->getArgument('message');
+
+		// options
+		$groups = $input->getOption('group');
+
+		// notification types
+		$activities = $input->getOption('activities');
+		$notifications = $input->getOption('notifications');
+		$emails = $input->getOption('emails');
+		$comments = $input->getOption('comments');
+
+		// times
+		try {
+			$scheduleTime = $this->parseTimestamp($input->getOption('schedule-time'));
+			$deleteTime = $this->parseTimestamp($input->getOption('delete-time'));
+		} catch(\InvalidArgumentException $e) {
+			$output->writeln($e->getMessage());
+			return 2;
+		}
+
+		// validation
+		if ($scheduleTime && $deleteTime && $deleteTime < $scheduleTime) {
+			$output->writeln('Publishing time is after deletion time');
+			return 2;
+		}
+
+		$plainMessage = $this->plainifyMessage($message);
+		$notificationOptions = $this->notificationType->setNotificationTypes($activities, $notifications, $emails);
+
+		$result = $this->manager->announce($subject, $message, $plainMessage, $user, $this->time->getTime(), $groups, $comments, $notificationOptions, $scheduleTime, $deleteTime);
+		$output->writeln("Created announcement #" . $result->getId() . ": " . $result->getSubject());
+
+		if ($scheduleTime) {
+			$output->writeln("Scheduled announcement for '" . date("D M j G:i:s T Y", $scheduleTime) . "'");
+		}
+
+		if ($deleteTime) {
+			$output->writeln("Scheduled deletion for '" . date("D M j G:i:s T Y", $deleteTime) . "'");
+		}
+
+		$this->logger->info('Admin ' . $user . ' posted a new announcement: "' . $result->getSubject() . '" over CLI');
+		return 0;
+	}
+
+	/**
+	 * Parses an arbitrary $argument into a timestamp
+	 * @param null|int|string $argument argument provided by CLI for a time
+	 *      Examples 1:
+	 *          '1711440621' a plain unix timestamp
+	 *      Examples 2 see strtotime (https://www.php.net/manual/de/function.strtotime.php):
+	 *          'now', 10 September 200', '+1 day', 'tomorrow'
+	 * @return int|null a timestamp, returns null if $argument is null
+	 * @throws \InvalidArgumentException If the time could not be interpreted or the time is in the past
+	 */
+	private function parseTimestamp(null|int|string $argument): int|null {
+		if (is_null($argument)) {
+			return null;
+		} elseif (is_numeric($argument)) {
+			$timestamp = intval($argument);
+		} elseif (($convTime = strtotime($argument)) !== false) {
+			$timestamp = $convTime;
+		} else {
+			throw new \InvalidArgumentException("Could not interprete time '" . $argument . "'");
+		}
+
+		if ($timestamp < $this->time->getTime()) {
+			throw new \InvalidArgumentException("Time '" . $argument . "' is not allowed, because it's in the past");
+		}
+		return $timestamp;
+	}
+}

lib/Command/AnnouncementDelete.php

@@ -0,0 +1,76 @@
+<?php
+/**
+ * @copyright Copyright (c) 2024 Marvin Winkens <m.winkens@fz-juelich.de>
+ *
+ * @author Marvin Winkens <m.winkens@fz-juelich.de>
+ *
+ * @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\AnnouncementCenter\Command;
+
+use InvalidArgumentException;
+use OCA\AnnouncementCenter\Manager;
+use OCP\AppFramework\Db\DoesNotExistException;
+use Psr\Log\LoggerInterface;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class AnnouncementDelete extends Command {
+	protected Manager $manager;
+	protected LoggerInterface $logger;
+	public function __construct(Manager $manager, LoggerInterface $logger) {
+		parent::__construct();
+		$this->manager = $manager;
+		$this->logger = $logger;
+	}
+
+	protected function configure(): void {
+		$this
+			->setName('announcementcenter:delete')
+			->setDescription('Delete announcement by id')
+			->addArgument(
+				'id',
+				InputArgument::REQUIRED,
+				'Id of announcement to delete',
+			);
+	}
+
+	protected function execute(InputInterface $input, OutputInterface $output): int {
+		try {
+			$deleteId = $this->parseId($input->getArgument('id'));
+			$this->manager->delete($deleteId);
+		} catch (DoesNotExistException) {
+			$output->writeln("Announcement with #" . $deleteId . " does not exist!");
+			return 1;
+		} catch (InvalidArgumentException $e) {
+			$output->writeln($e->getMessage());
+			return 1;
+		}
+		$output->writeln("Successfully deleted #" . $deleteId);
+		$this->logger->info('Admin deleted announcement #' . $deleteId . ' over CLI');
+		return 0;
+	}
+
+	private function parseId(mixed $value) {
+		if (is_numeric($value)) {
+			return intval($value);
+		}
+		throw new InvalidArgumentException('Id "' . $value . '" is not an integer');
+	}
+}

lib/Command/AnnouncementList.php

@@ -0,0 +1,104 @@
+<?php
+/**
+ * @copyright Copyright (c) 2024 Marvin Winkens <m.winkens@fz-juelich.de>
+ *
+ * @author Marvin Winkens <m.winkens@fz-juelich.de>
+ *
+ * @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\AnnouncementCenter\Command;
+
+use OCA\AnnouncementCenter\Manager;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Terminal;
+
+class AnnouncementList extends Command {
+	protected Manager $manager;
+	public function __construct(Manager $manager) {
+		parent::__construct();
+		$this->manager = $manager;
+	}
+
+	protected function configure(): void {
+		$this
+			->setName('announcementcenter:list')
+			->setDescription('List all announcements')
+			->addArgument(
+				'limit',
+				InputArgument::OPTIONAL,
+				'Maximal number of announcements listed',
+				10,
+			);
+	}
+
+	protected function execute(InputInterface $input, OutputInterface $output): int {
+		$ulimit = $input->getArgument('limit');
+		if (!is_numeric($ulimit)) {
+			$output->writeln('"' . $ulimit . '" is not numeric');
+			return 1;
+		}
+		$ulimit = intval($ulimit);
+		$announcements = $this->manager->getAnnouncements(0, $ulimit + 1);
+
+		// Calculate table size
+		$terminal = new Terminal();
+		$width = $terminal->getWidth();
+		$minimalWidth = 6;
+		$minimalWidthText = 10;
+		$widthSubject = max($minimalWidthText, intdiv($width - $minimalWidth, 3));
+		$widthMessage = max($minimalWidthText, $width - $minimalWidth - $widthSubject);
+
+		$widths = [$minimalWidth - 2, $widthSubject, $widthMessage];
+		$text = $this->formatTableRow(["ID", "Subject", "Message"], $widths);
+		$output->writeln($text);
+		$text = $this->formatTableRow(["", "", ""], $widths, "-");
+		$output->writeln($text);
+
+		foreach ($announcements as $index => $ann) {
+			if ($index === $ulimit) {
+				$output->writeln("And more ...");
+				break;
+			}
+			$texts = [$ann->getId(), $ann->getParsedSubject(), $ann->getPlainMessage()];
+
+			$text = $this->formatTableRow($texts, $widths);
+			$output->writeln($text);
+		}
+		return 0;
+	}
+
+	private function ellipseAndPadText(string $text, int $width, string $sep = " "): string {
+		$text = str_pad($text, $width, $sep, STR_PAD_RIGHT);
+		$text = strlen($text) > $width ? substr($text, 0, $width - 3) . "..." : $text;
+		return $text;
+	}
+
+	private function formatTableRow(array $texts, array $widths, string $sep = " "): string {
+		$callback = function ($a, $b) use ($sep) {
+			return $this->ellipseAndPadText($a, $b, $sep);
+		};
+		$formattedTexts = array_map(
+			$callback,
+			$texts,
+			$widths
+		);
+		return implode("|", $formattedTexts);
+	}
+}