feat: add support for comments in forms

Signed-off-by: Christian Hartmann <chris-hartmann@gmx.de>

Author: Chartman123

lib/AppInfo/Application.php

@@ -13,13 +13,15 @@
 use OCA\Forms\Capabilities;
 use OCA\Forms\FormsMigrator;
 use OCA\Forms\Listener\AnalyticsDatasourceListener;
+use OCA\Forms\Listener\CommentsEntityListener;
 use OCA\Forms\Listener\UserDeletedListener;
 use OCA\Forms\Middleware\ThrottleFormAccessMiddleware;
 use OCA\Forms\Search\SearchProvider;
 use OCP\AppFramework\App;
 use OCP\AppFramework\Bootstrap\IBootContext;
 use OCP\AppFramework\Bootstrap\IBootstrap;
 use OCP\AppFramework\Bootstrap\IRegistrationContext;
+use OCP\Comments\CommentsEntityEvent;
 use OCP\User\Events\UserDeletedEvent;
 
 class Application extends App implements IBootstrap {
@@ -44,6 +46,7 @@ public function register(IRegistrationContext $context): void {
 		$context->registerCapability(Capabilities::class);
 		$context->registerEventListener(UserDeletedEvent::class, UserDeletedListener::class);
 		$context->registerEventListener(DatasourceEvent::class, AnalyticsDatasourceListener::class);
+		$context->registerEventListener(CommentsEntityEvent::class, CommentsEntityListener::class);
 		$context->registerMiddleware(ThrottleFormAccessMiddleware::class);
 		$context->registerSearchProvider(SearchProvider::class);
 		$context->registerUserMigrator(FormsMigrator::class);

lib/Constants.php

@@ -20,6 +20,7 @@ class Constants {
 	public const CONFIG_KEY_RESTRICTCREATION = 'restrictCreation';
 	public const CONFIG_KEY_ALLOWCONFIRMATIONEMAIL = 'allowConfirmationEmail';
 	public const CONFIG_KEY_CONFIRMATIONEMAILRATELIMIT = 'confirmationEmailRateLimit';
+	public const CONFIG_KEY_ALLOWCOMMENTS = 'allowComments';
 	public const CONFIG_KEYS = [
 		self::CONFIG_KEY_ALLOWPERMITALL,
 		self::CONFIG_KEY_ALLOWPUBLICLINK,
@@ -28,6 +29,7 @@ class Constants {
 		self::CONFIG_KEY_RESTRICTCREATION,
 		self::CONFIG_KEY_ALLOWCONFIRMATIONEMAIL,
 		self::CONFIG_KEY_CONFIRMATIONEMAILRATELIMIT,
+		self::CONFIG_KEY_ALLOWCOMMENTS,
 	];
 	public const CONFIG_KEY_TYPES = [
 		self::CONFIG_KEY_ALLOWPERMITALL => 'bool',

lib/Controller/PageController.php

@@ -29,6 +29,7 @@
 use OCP\AppFramework\Http\Template\PublicTemplateResponse;
 use OCP\AppFramework\Http\TemplateResponse;
 use OCP\AppFramework\Services\IInitialState;
+use OCP\Comments\ICommentsManager;
 use OCP\IL10N;
 use OCP\IRequest;
 use OCP\IURLGenerator;
@@ -51,6 +52,7 @@ public function __construct(
 		private FormsService $formsService,
 		private IAccountManager $accountManager,
 		private IInitialState $initialState,
+		private ICommentsManager $commentsManager,
 		private IL10N $l10n,
 		private IUrlGenerator $urlGenerator,
 		private IUserManager $userManager,
@@ -66,7 +68,9 @@ public function __construct(
 	#[NoCSRFRequired()]
 	#[FrontpageRoute(verb: 'GET', url: '/')]
 	public function index(?string $hash = null, ?int $submissionId = null): TemplateResponse {
-		Util::addScript($this->appName, 'forms-main');
+		// Ensure the Comments client is available and load comments resources
+		$this->commentsManager->load();
+		Util::addScript($this->appName, 'forms-main', 'comments');
 		Util::addStyle($this->appName, 'forms');
 		Util::addStyle($this->appName, 'forms-style');
 		$this->insertHeaderOnIos();

lib/Db/Form.php

@@ -61,6 +61,8 @@
  * @method void setConfirmationEmailBody(string|null $value)
  * @method int|null getConfirmationEmailQuestionId()
  * @method void setConfirmationEmailQuestionId(int|null $value)
+ * @method bool getAllowComments()
+ * @method void setAllowComments(bool $value)
  */
 class Form extends Entity {
 	protected $hash;
@@ -86,6 +88,7 @@ class Form extends Entity {
 	protected $confirmationEmailSubject;
 	protected $confirmationEmailBody;
 	protected $confirmationEmailQuestionId;
+	protected $allowComments;
 
 	/**
 	 * Form constructor.
@@ -104,6 +107,7 @@ public function __construct() {
 		$this->addType('maxSubmissions', 'integer');
 		$this->addType('confirmationEmailEnabled', 'boolean');
 		$this->addType('confirmationEmailQuestionId', 'integer');
+		$this->addType('allowComments', 'boolean');
 	}
 
 	// JSON-Decoding of access-column.
@@ -182,6 +186,7 @@ public function setAccess(array $access): void {
 	 *   confirmationEmailSubject: ?string,
 	 *   confirmationEmailBody: ?string,
 	 *   confirmationEmailQuestionId: ?int,
+	 *   allowComments: bool,
 	 *  }
 	 */
 	public function read() {
@@ -210,6 +215,7 @@ public function read() {
 			'confirmationEmailSubject' => $this->getConfirmationEmailSubject(),
 			'confirmationEmailBody' => $this->getConfirmationEmailBody(),
 			'confirmationEmailQuestionId' => $this->getConfirmationEmailQuestionId(),
+			'allowComments' => $this->getAllowComments(),
 		];
 	}
 }

lib/Db/FormMapper.php

@@ -11,6 +11,7 @@
 use OCA\Forms\Service\ConfigService;
 use OCP\AppFramework\Db\Entity;
 use OCP\AppFramework\Db\QBMapper;
+use OCP\Comments\ICommentsManager;
 use OCP\DB\QueryBuilder\IQueryBuilder;
 use OCP\IDBConnection;
 use OCP\Share\IShare;
@@ -30,6 +31,7 @@ public function __construct(
 		private ShareMapper $shareMapper,
 		private SubmissionMapper $submissionMapper,
 		private ConfigService $configService,
+		private ICommentsManager $commentsManager,
 	) {
 		parent::__construct($db, 'forms_v2_forms', Form::class);
 	}
@@ -218,9 +220,11 @@ public function findAllByOwnerId(string $ownerId, ?string $queryTerm = null): ar
 	 */
 	public function deleteForm(Form $form): void {
 		// Delete Submissions(incl. Answers), Questions(incl. Options), Shares and Form.
-		$this->submissionMapper->deleteByForm($form->getId());
-		$this->shareMapper->deleteByForm($form->getId());
-		$this->questionMapper->deleteByForm($form->getId());
+		$formId = $form->getId();
+		$this->submissionMapper->deleteByForm($formId);
+		$this->shareMapper->deleteByForm($formId);
+		$this->questionMapper->deleteByForm($formId);
+		$this->commentsManager->deleteCommentsAtObject('forms', (string)$formId);
 		$this->delete($form);
 	}
 }

lib/FormsMigrator.php

@@ -153,6 +153,7 @@ public function import(IUser $user, IImportSource $importSource, OutputInterface
 				$form->setConfirmationEmailSubject($formData['confirmationEmailSubject'] ?? null);
 				$form->setConfirmationEmailBody($formData['confirmationEmailBody'] ?? null);
 				$form->setConfirmationEmailQuestionId(null); // Set to null initially, updated after questions are imported
+				$form->setAllowComments($formData['allowComments'] ?? false);
 
 				$this->formMapper->insert($form);
 

lib/Listener/CommentsEntityListener.php

@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Forms\Listener;
+
+use OCA\Forms\Db\FormMapper;
+use OCA\Forms\Service\FormsService;
+use OCP\AppFramework\Db\DoesNotExistException;
+use OCP\Comments\CommentsEntityEvent;
+use OCP\EventDispatcher\Event;
+use OCP\EventDispatcher\IEventListener;
+
+/**
+ * @template-implements IEventListener<Event>
+ */
+class CommentsEntityListener implements IEventListener {
+	public function __construct(
+		protected FormMapper $formMapper,
+		protected FormsService $formService,
+	) {
+	}
+
+	#[\Override]
+	public function handle(Event $event): void {
+		if (!$event instanceof CommentsEntityEvent) {
+			return;
+		}
+
+		// Register the 'forms' entity collection so the Comments app can
+		// check whether a given form id allows comments.
+		$event->addEntityCollection('forms', function ($formId) {
+			try {
+				$form = $this->formMapper->findById((int)$formId);
+			} catch (DoesNotExistException $e) {
+				return false;
+			}
+			return $this->formService->hasUserAccess($form) && $form->getAllowComments();
+		});
+	}
+}

lib/Migration/Version050300Date20260511121033.php

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Forms\Migration;
+
+use Closure;
+use OCP\DB\ISchemaWrapper;
+use OCP\DB\Types;
+use OCP\Migration\IOutput;
+use OCP\Migration\SimpleMigrationStep;
+use Override;
+
+class Version050300Date20260511121033 extends SimpleMigrationStep {
+
+	/**
+	 * @param IOutput $output
+	 * @param Closure(): ISchemaWrapper $schemaClosure
+	 * @param array $options
+	 * @return null|ISchemaWrapper
+	 */
+	#[Override]
+	public function changeSchema(IOutput $output, Closure $schemaClosure, array $options): ?ISchemaWrapper {
+		/** @var ISchemaWrapper $schema */
+		$schema = $schemaClosure();
+		$table = $schema->getTable('forms_v2_forms');
+		$changed = false;
+
+		if (!$table->hasColumn('allow_comments')) {
+			$table->addColumn('allow_comments', Types::BOOLEAN, [
+				'notnull' => false,
+				'default' => 0,
+			]);
+			$changed = true;
+		}
+
+		return $changed ? $schema : null;
+	}
+}

lib/ResponseDefinitions.php

@@ -146,6 +146,7 @@
  *   confirmationEmailSubject: ?string,
  *   confirmationEmailBody: ?string,
  *   confirmationEmailQuestionId: ?int,
+ *   allowComments: bool,
  * }
  *
  * @psalm-type FormsUploadedFile = array{

lib/Service/ConfigService.php

@@ -64,6 +64,10 @@ public function getConfirmationEmailRateLimit(): int {
 		return $this->appConfig->getAppValueInt(Constants::CONFIG_KEY_CONFIRMATIONEMAILRATELIMIT, 3);
 	}
 
+	public function getAllowComments(): bool {
+		return $this->appConfig->getAppValueBool(Constants::CONFIG_KEY_ALLOWCOMMENTS, false);
+	}
+
 	/**
 	 * Provide the full AppConfig
 	 */
@@ -77,6 +81,7 @@ public function getAppConfig(): array {
 			Constants::CONFIG_KEY_ALLOWCONFIRMATIONEMAIL => $this->getAllowConfirmationEmail(),
 			Constants::CONFIG_KEY_CONFIRMATIONEMAILRATELIMIT => $this->getConfirmationEmailRateLimit(),
 			'isMailConfigured' => $this->isMailConfigured(),
+			Constants::CONFIG_KEY_ALLOWCOMMENTS => $this->getAllowComments(),
 
 			// Additional, calculated information out of Config
 			'canCreateForms' => $this->canCreateForms()