feat: mail snippets

Signed-off-by: Hamza Mahjoubi <[email protected]>

appinfo/info.xml

@@ -34,7 +34,7 @@ The rating depends on the installed text processing backend. See [the rating ove
 
 Learn more about the Nextcloud Ethical AI Rating [in our blog](https://nextcloud.com/blog/nextcloud-ethical-ai-rating/).
 	]]></description>
-	<version>4.1.0-alpha.2</version>
+	<version>4.1.0-alpha.4</version>
 	<licence>agpl</licence>
 	<author homepage="https://github.com/ChristophWurst">Christoph Wurst</author>
 	<author homepage="https://github.com/GretaD">GretaD</author>

lib/Db/Snippet.php

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2021 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Mail\Db;
+
+use JsonSerializable;
+use OCP\AppFramework\Db\Entity;
+use ReturnTypeWillChange;
+
+/**
+ * @method string getOwner()
+ * @method void setOwner(string $owner)
+ * @method string geTitle()
+ * @method void setTitle(string $title)
+ * @method string getContent()
+ * @method void setContent(string $content)
+ */
+class Snippet extends Entity implements JsonSerializable {
+	protected $owner;
+	protected $title;
+	protected $content;
+
+	public function __construct() {
+		$this->addType('owner', 'string');
+		$this->addType('title', 'string');
+		$this->addType('content', 'string');
+	}
+
+	#[ReturnTypeWillChange]
+	public function jsonSerialize() {
+		return [
+			'id' => $this->getId(),
+			'owner' => $this->getOwner(),
+			'title' => $this->geTitle(),
+			'content' => $this->getContent(),
+		];
+	}
+}

lib/Db/SnippetMapper.php

@@ -0,0 +1,82 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Mail\Db;
+
+use OCP\AppFramework\Db\DoesNotExistException;
+use OCP\AppFramework\Db\QBMapper;
+use OCP\DB\QueryBuilder\IQueryBuilder;
+use OCP\IDBConnection;
+
+/**
+ * @template-extends QBMapper<Snippet>
+ */
+class SnippetMapper extends QBMapper {
+	/**
+	 * @param IDBConnection $db
+	 */
+	public function __construct(IDBConnection $db) {
+		parent::__construct($db, 'mail_snippets');
+	}
+
+	/**
+	 * @param int $id
+	 * @param string $owner
+	 * @return Snippet
+	 *
+	 * @throws DoesNotExistException
+	 */
+	public function find(int $id, string $owner): Snippet {
+		$qb = $this->db->getQueryBuilder();
+		$qb->select('*')
+			->from($this->getTableName())
+			->where($qb->expr()->eq('id', $qb->createNamedParameter($id)))
+			->andWhere($qb->expr()->eq('owner', $qb->createNamedParameter($owner)));
+
+		return $this->findEntity($qb);
+	}
+
+	/**
+	 * @param string $owner
+	 * @return Snippet[]
+	 */
+	public function findAll(string $owner): array {
+		$qb = $this->db->getQueryBuilder();
+		$qb->select('*')
+			->from($this->getTableName())
+			->where(
+				$qb->expr()->eq('owner', $qb->createNamedParameter($owner, IQueryBuilder::PARAM_STR))
+			);
+
+		return $this->findEntities($qb);
+	}
+
+	/**
+	 * @param string $userId
+	 * @param array $groups
+	 * @return Snippet[]
+	 */
+	public function findSharedWithMe(string $userId, array $groups): array {
+		$qb = $this->db->getQueryBuilder();
+		$qb->select('s.*')
+			->from($this->getTableName(), 's')
+			->join('s', 'mail_snippets_shares', 'share', $qb->expr()->eq('s.id', 'sshare.snippet_id'))
+			->where($qb->expr()->andX(
+				$qb->expr()->eq('sshare.share_with', $qb->createNamedParameter($userId, IQueryBuilder::PARAM_STR)),
+				$qb->expr()->in('sshare.type', $qb->createNamedParameter('user', IQueryBuilder::PARAM_STR))
+			))
+			->orWhere(
+				$qb->expr()->andX(
+					$qb->expr()->in('sshare.share_with', $qb->createNamedParameter($groups, IQueryBuilder::PARAM_STR_ARRAY)),
+					$qb->expr()->in('sshare.type', $qb->createNamedParameter('group', IQueryBuilder::PARAM_STR))
+				)
+			);
+		return $this->findEntities($qb);
+	}
+}

lib/Db/SnippetShare.php

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2021 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Mail\Db;
+
+use JsonSerializable;
+use OCP\AppFramework\Db\Entity;
+use ReturnTypeWillChange;
+
+/**
+ * @method string getType()
+ * @method void setType(string $type)
+ * @method string getShareWith()
+ * @method void setShareWith((string $shareWith)
+ * @method string getSnippetId()
+ * @method void setSnippetId(string $snippetId)
+ */
+class SnippetShare extends Entity implements JsonSerializable {
+	protected $owner;
+	protected $title;
+	protected $content;
+
+	public function __construct() {
+		$this->addType('type', 'string');
+		$this->addType('shareWith', 'string');
+		$this->addType('snippetId', 'string');
+	}
+
+	#[ReturnTypeWillChange]
+	public function jsonSerialize() {
+		return [
+			'id' => $this->getId(),
+			'type' => $this->getType(),
+			'shareWith' => $this->getShareWith(),
+			'snippetId' => $this->getSnippetId(),
+		];
+	}
+}

lib/Db/SnippetShareMapper.php

@@ -0,0 +1,82 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Mail\Db;
+
+use OCP\AppFramework\Db\DoesNotExistException;
+use OCP\AppFramework\Db\QBMapper;
+use OCP\DB\QueryBuilder\IQueryBuilder;
+use OCP\IDBConnection;
+
+/**
+ * @template-extends QBMapper<SnippetShare>
+ */
+class SnippetShareMapper extends QBMapper {
+	/**
+	 * @param IDBConnection $db
+	 */
+	public function __construct(IDBConnection $db) {
+		parent::__construct($db, 'mail_snippets_shares');
+	}
+
+	/**
+	 * @param int $id
+	 * @param string $owner
+	 * @return Snippet
+	 *
+	 * @throws DoesNotExistException
+	 */
+	public function find(int $id, string $owner): Snippet {
+		$qb = $this->db->getQueryBuilder();
+		$qb->select('*')
+			->from($this->getTableName())
+			->where($qb->expr()->eq('id', $qb->createNamedParameter($id)))
+			->andWhere($qb->expr()->eq('owner', $qb->createNamedParameter($owner)));
+
+		return $this->findEntity($qb);
+	}
+
+	/**
+	 * @param string $owner
+	 * @return SnippetShare[]
+	 */
+	public function findAllShares(string $owner): array {
+		$qb = $this->db->getQueryBuilder();
+		$qb->select('sshare.*')
+			->from($this->getTableName(), 'sshare')
+			->join('sshare', 'mail_snippets', 's', $qb->expr()->eq('sshare.snippet_id', 's.id', IQueryBuilder::PARAM_INT))
+			->where(
+				$qb->expr()->eq('s.owner', $qb->createNamedParameter($owner, IQueryBuilder::PARAM_STR))
+			);
+
+		return $this->findEntities($qb);
+	}
+
+	/**
+	 * @param string $owner
+	 * @param string $snippetId
+	 *
+	 * @return SnippetShare[]
+	 */
+	public function findSnippetShares(string $owner, string $snippetId): array {
+		$qb = $this->db->getQueryBuilder();
+		$qb->select('sshare.*')
+			->from($this->getTableName(), 'sshare')
+			->where(
+				$qb->expr()->eq('s.owner', $qb->createNamedParameter($owner, IQueryBuilder::PARAM_STR))
+			)
+			->andWhere(
+				$qb->expr()->eq('sshare.snippet_id', $qb->createNamedParameter($snippetId, IQueryBuilder::PARAM_STR))
+			);
+
+		return $this->findEntities($qb);
+	}
+
+
+}

lib/Migration/Version4001Date20241017154801.php

@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Mail\Migration;
+
+use Closure;
+use OCP\DB\ISchemaWrapper;
+use OCP\DB\Types;
+use OCP\Migration\IOutput;
+use OCP\Migration\SimpleMigrationStep;
+
+class Version4001Date20241017154801 extends SimpleMigrationStep {
+	/**
+	 * @param IOutput $output
+	 * @param Closure(): ISchemaWrapper $schemaClosure
+	 * @param array $options
+	 * @return ISchemaWrapper
+	 */
+	public function changeSchema(IOutput $output, Closure $schemaClosure, array $options): ?ISchemaWrapper {
+		/** @var ISchemaWrapper $schema */
+		$schema = $schemaClosure();
+		$table = $schema->createTable('mail_snippets');
+
+		$table->addColumn('id', Types::INTEGER, [
+			'autoincrement' => true,
+			'notnull' => true,
+			'length' => 4,
+		]);
+		$table->addColumn('owner', Types::STRING, [
+			'notnull' => true,
+			'length' => 64,
+		]);
+		$table->addColumn('title', Types::STRING, [
+			'notnull' => true,
+			'length' => 64,
+		]);
+		$table->addColumn('content', Types::TEXT, [
+			'notnull' => true,
+		]);
+		$table->setPrimaryKey(['id']);
+
+		return $schema;
+	}
+}

lib/Migration/Version4001Date20241017155914.php

@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Mail\Migration;
+
+use Closure;
+use OCP\DB\ISchemaWrapper;
+use OCP\DB\Types;
+use OCP\Migration\IOutput;
+use OCP\Migration\SimpleMigrationStep;
+
+class Version4001Date20241017155914 extends SimpleMigrationStep {
+	/**
+	 * @param IOutput $output
+	 * @param Closure(): ISchemaWrapper $schemaClosure
+	 * @param array $options
+	 * @return ISchemaWrapper
+	 */
+	public function changeSchema(IOutput $output, Closure $schemaClosure, array $options): ?ISchemaWrapper {
+		/** @var ISchemaWrapper $schema */
+		$schema = $schemaClosure();
+		$table = $schema->createTable('mail_snippets_shares');
+
+		$table->addColumn('id', Types::INTEGER, [
+			'autoincrement' => true,
+			'notnull' => true,
+			'length' => 4,
+		]);
+		$table->addColumn('type', Types::STRING, [
+			'notnull' => true,
+			'length' => 64,
+		]);
+		$table->addColumn('share_with', Types::STRING, [
+			'notnull' => true,
+			'length' => 64,
+		]);
+		$table->addColumn('snippet_id', Types::STRING, [
+			'notnull' => true,
+			'length' => 64,
+		]);
+		$table->setPrimaryKey(['id']);
+		return $schema;
+	}
+}

src/components/AppSettingsMenu.vue

@@ -291,6 +291,12 @@
 					</div>
 				</dl>
 			</NcAppSettingsSection>
+			<NcAppSettingsSection id="snippets" :name="t('mail', 'Snippets')">
+				<h6>{{ t('mail','My snippets') }}</h6>
+				<ListItem />
+				<h6>{{ t('mail','Shared with me') }}</h6>
+				<ListItem />
+			</NcAppSettingsSection>
 		</NcAppSettingsDialog>
 	</div>
 </template>
@@ -313,6 +319,7 @@ import TrustedSenders from './TrustedSenders.vue'
 import InternalAddress from './InternalAddress.vue'
 import isMobile from '@nextcloud/vue/dist/Mixins/isMobile.js'
 import { mapGetters } from 'vuex'
+import ListItem from './snippets/ListItem.vue'
 
 export default {
 	name: 'AppSettingsMenu',
@@ -331,6 +338,7 @@ export default {
 		CompactMode,
 		VerticalSplit,
 		HorizontalSplit,
+		ListItem,
 	},
 	mixins: [isMobile],
 	props: {