feat: Create shares list report + send it by email + diff

Co-Authored-By: Florent Poinsaut <florent@solution-libre.fr>
Signed-off-by: Carl Schwan <carl.schwan@nextcloud.com>

Author: CarlSchwan

README.md

@@ -4,7 +4,9 @@ This app allows generating reports of shares on the system.
 
 ## Usage
 
-### Command
+### Commands
+
+#### List
 
 ```sh
 ./occ sharing:list [-u|--user [USER]] [-p|--path [PATH]] [-t|--token [TOKEN]] [-f|--filter [FILTER]] [-o|--output FORMAT]
@@ -13,7 +15,7 @@ This app allows generating reports of shares on the system.
 Without options, the command yields the unfiltered list of all shares.\
 With options, the list is narrowed down using the filters set.
 
-### Options
+##### Options
 
 * `-u [USER]` or `--user [USER]`\
   List only shares of the given user.
@@ -27,6 +29,33 @@ With options, the list is narrowed down using the filters set.
 * `-o FORMAT` or `--output FORMAT`\
   Set the output format (json or csv, default is json).
 
+#### Send
+
+```sh
+./occ sharing:send [-u|--user USER] [-p|--path PATH] [-t|--token TOKEN] [-f|--filter FILTER] [-o|--output FORMAT]
+```
+
+Without options, the command yields the unfiltered list of all shares.\
+With options, the list is narrowed down using the filters set.
+
+##### Options
+
+* `-r` or `--recipients`\
+  Recipients users of generated reports.
+* `-x` or `--target-path`\
+  Generated reports will be stored on this path.
+* `-d` or `--diff`\
+  Create a differential report in json format from the last available report.
+* `-u [USER]` or `--user [USER]`\
+  List only shares of the given user.
+* `-p [PATH]` or `--path [PATH]`\
+  List only shares within the given path.
+* `-t [TOKEN]` or `--token [TOKEN]`\
+  List only shares that use a token that (at least partly) matches the argument.
+* `-f [FILTER]` or `--filter [FILTER]`\
+  List only shares where the TYPE matches the argument.\
+  Possible values for the filter argument: {owner, initiator, recipient}
+
 ## Examples
 
 To better illustrate how the app work see the examples below:

composer.json

@@ -39,6 +39,7 @@
 	"require": {
 		"nikic/iter": "^2.4",
 		"symfony/serializer": "^5.4",
-		"bamarni/composer-bin-plugin": "^1.8"
+		"bamarni/composer-bin-plugin": "^1.8",
+		"swaggest/json-diff": "^3.12"
 	}
 }

composer.lock

@@ -0,0 +1,78 @@
+<?php
+declare(strict_types=1);
+/**
+ * @copyright Copyright (c) 2022 Solution Libre SAS
+ * @copyright Copyright (c) 2018 Roeland Jago Douma <roeland@famdouma.nl>
+ *
+ * @author Florent Poinsaut <florent@solution-libre.fr>
+ * @author Roeland Jago Douma <roeland@famdouma.nl>
+ * @author John Molakvoæ <skjnldsv@protonmail.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\ShareListing\Command;
+
+use OCA\ShareListing\Service\SharesList;
+use OC\Core\Command\Base;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+
+abstract class AbstractCommand extends Base {
+	/** @var SharesList */
+	protected $sharesList;
+
+	public function __construct(SharesList $sharesList) {
+		parent::__construct();
+
+		$this->sharesList = $sharesList;
+	}
+
+	public function configure() {
+		$this->addOption(
+				'user',
+				'u',
+				InputOption::VALUE_OPTIONAL,
+				'Will list shares of the given user'
+			)
+			->addOption(
+				'path',
+				'p',
+				InputOption::VALUE_OPTIONAL,
+				'Will only consider the given path'
+			)->addOption(
+				'token',
+				't',
+				InputOption::VALUE_OPTIONAL,
+				'Will only consider the given token'
+			)->addOption(
+				'filter',
+				'f',
+				InputOption::VALUE_OPTIONAL,
+				'Filter shares, possible values: owner, initiator, recipient, token, has-expiration, no-expiration'
+			);
+	}
+
+	protected function getOptions(InputInterface $input): array {
+		$user = $input->getOption('user');
+		$path = $input->getOption('path');
+		$token = $input->getOption('token');
+		$filter = $this->sharesList->filterStringToInt($input->getOption('filter'));
+
+		return [$user, $path, $token, $filter];
+	}
+}

lib/Command/AbstractCommand.php

@@ -27,53 +27,15 @@
 
 namespace OCA\ShareListing\Command;
 
-use OC\Core\Command\Base;
-use OCA\ShareListing\Service\SharesList;
-use OCP\Files\IRootFolder;
-use OCP\IUserManager;
-use OCP\Share\IManager as ShareManager;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 use function iter\toArray;
 
-class ListShares extends Base {
-
-	public function __construct(
-		private ShareManager $shareManager,
-		private IUserManager $userManager,
-		private IRootFolder $rootFolder,
-		private SharesList $sharesList,
-	) {
-		parent::__construct();
-
-	}
-
+class ListShares extends AbstractCommand {
 	public function configure() {
 		$this->setName('sharing:list')
 			->setDescription('List who has access to shares by owner')
-			->addOption(
-				'user',
-				'u',
-				InputOption::VALUE_OPTIONAL,
-				'Will list shares of the given user'
-			)
-			->addOption(
-				'path',
-				'p',
-				InputOption::VALUE_OPTIONAL,
-				'Will only consider the given path'
-			)->addOption(
-				'token',
-				't',
-				InputOption::VALUE_OPTIONAL,
-				'Will only consider the given token'
-			)->addOption(
-				'filter',
-				'f',
-				InputOption::VALUE_OPTIONAL,
-				'Filter shares, possible values: owner, initiator, recipient, token, has-expiration, no-expiration'
-			)
 			->addOption(
 				'output',
 				'o',
@@ -84,10 +46,7 @@ public function configure() {
 	}
 
 	protected function execute(InputInterface $input, OutputInterface $output): int {
-		$user = $input->getOption('user');
-		$path = $input->getOption('path');
-		$token = $input->getOption('token');
-		$filter = $this->sharesList->filterStringToInt($input->getOption('filter'));
+		[$user, $path, $token, $filter] = $this->getOptions($input);
 		$outputOpt = $input->getOption('output');
 
 		$shares = toArray($this->sharesList->getFormattedShares($user, $filter, $path, $token));