transfer ownership of a form

Signed-off-by: hamza221 <hamzamahjoubi221@gmail.com>

Author: hamza221

appinfo/routes.php

@@ -127,6 +127,14 @@
 				'apiVersion' => 'v2.2'
 			]
 		],
+		[
+			'name' => 'api#transferOwner',
+			'url' => '/api/{apiVersion}/form/transfer',
+			'verb' => 'POST',
+			'requirements' => [
+				'apiVersion' => 'v2.2'
+			]
+		],
 		[
 			'name' => 'api#deleteForm',
 			'url' => '/api/{apiVersion}/form/{id}',

docs/API.md

@@ -221,6 +221,20 @@ Update a single or multiple properties of a form-object. Concerns **only** the F
 ```
 "data": 3
 ```
+### Transfer form ownership
+Transfer the ownership of a form to another user
+- Endpoint: `/api/v2.2/form/transfer`
+- Method: `POST`
+- Parameters:
+  | Parameter | Type    | Description |
+  |-----------|---------|-------------|
+  | _formId_      | Integer | ID of the form to tranfer |
+  | _uid_ | Integer | ID of the new form owner |
+- Restrictions: The initiator must be the current form owner.
+- Response: **Status-Code OK**, as well as the id of the new owner.
+```
+"data": "user1"
+```
 
 ### Delete a form
 - Endpoint: `/api/v2.2/form/{id}`

lib/Controller/ApiController.php

@@ -51,6 +51,7 @@
 use OCP\AppFramework\OCS\OCSException;
 use OCP\AppFramework\OCS\OCSForbiddenException;
 use OCP\AppFramework\OCSController;
+use OCP\Files\NotFoundException;
 use OCP\Files\NotPermittedException;
 use OCP\IL10N;
 use OCP\IRequest;
@@ -351,6 +352,50 @@ public function updateForm(int $id, array $keyValuePairs): DataResponse {
 		return new DataResponse($form->getId());
 	}
 
+	/**
+	 * @NoAdminRequired
+	 *
+	 * Transfer ownership of a form to another user
+	 *
+	 * @param int $formId id of the form to update
+	 * @param string $uid id of the new owner
+	 * @return DataResponse
+	 * @throws OCSBadRequestException
+	 * @throws OCSForbiddenException
+	 */
+	public function transferOwner(int $formId, string $uid): DataResponse {
+		$this->logger->debug('Updating owner: formId: {formId}, userId: {uid}', [
+			'formId' => $formId,
+			'uid' => $uid
+		]);
+
+		try {
+			$form = $this->formMapper->findById($formId);
+		} catch (IMapperException $e) {
+			$this->logger->debug('Could not find form');
+			throw new NotFoundException('Could not find form');
+		}
+
+		$user = $this->userManager->get($uid);
+		if($user == null) {
+			$this->logger->debug('Could not find new form owner');
+			throw new OCSBadRequestException('Could not find new form owner');
+		}
+
+		if ($form->getOwnerId() !== $this->currentUser->getUID()) {
+			$this->logger->debug('This form is not owned by the current user');
+			throw new OCSForbiddenException('This form is not owned by the current user');
+		}
+
+		// update form owner
+		$form->setOwnerId($uid);
+
+		// Update changed Columns in Db.
+		$this->formMapper->update($form);
+		
+		return new DataResponse($form->getOwnerId());
+	}
+
 	/**
 	 * @CORS
 	 * @NoAdminRequired

lib/Db/ShareMapper.php

@@ -103,7 +103,28 @@ public function findPublicShareByHash(string $hash): Share {
 
 		return $this->findEntity($qb);
 	}
+	/**
+	 * Find Share by formId and user id
+	 * @param int $formId
+	 * @param string $uid
+	 * @return Share
+	 * @throws MultipleObjectsReturnedException if more than one result
+	 * @throws DoesNotExistException if not found
+	 */
+	public function findPublicShareByFormIdAndUid(int $formId, string $uid): Share {
+		$qb = $this->db->getQueryBuilder();
 
+		$qb->select('*')
+			->from($this->getTableName())
+			->where(
+				$qb->expr()->eq('form_id', $qb->createNamedParameter($formId, IQueryBuilder::PARAM_INT))
+			)
+			->andWhere(
+				$qb->expr()->eq('share_with', $qb->createNamedParameter($uid, IQueryBuilder::PARAM_STR))
+			);
+
+		return $this->findEntity($qb);
+	}
 	/**
 	 * Delete a share
 	 * @param int $id of the share.

src/Forms.vue

@@ -230,10 +230,12 @@ export default {
 
 	mounted() {
 		subscribe('forms:last-updated:set', (id) => this.onLastUpdatedByEventBus(id))
+		subscribe('forms:ownership-transfered', (id) => this.onDeleteForm(id))
 	},
 
 	unmounted() {
 		unsubscribe('forms:last-updated:set', (id) => this.onLastUpdatedByEventBus(id))
+		unsubscribe('forms:ownership-transfered', (id) => this.onDeleteForm(id))
 	},
 
 	methods: {

src/components/SidebarTabs/SettingsSidebarTab.vue

@@ -88,6 +88,8 @@
 				{{ t('forms', 'Message to show after a user submitted the form. Please note that the message will not be translated!') }}
 			</div>
 		</div>
+
+		<TransferOwnership :form="form" />
 	</div>
 </template>
 
@@ -96,6 +98,7 @@ import moment from '@nextcloud/moment'
 import NcCheckboxRadioSwitch from '@nextcloud/vue/dist/Components/NcCheckboxRadioSwitch.js'
 import NcDateTimePicker from '@nextcloud/vue/dist/Components/NcDateTimePicker.js'
 import ShareTypes from '../../mixins/ShareTypes.js'
+import TransferOwnership from './TransferOwnership.vue'
 
 import { directive as ClickOutside } from 'v-click-outside'
 import { loadState } from '@nextcloud/initial-state'
@@ -104,6 +107,7 @@ export default {
 	components: {
 		NcCheckboxRadioSwitch,
 		NcDateTimePicker,
+		TransferOwnership,
 	},
 
 	directives: {
@@ -286,6 +290,11 @@ export default {
 	margin-inline-start: 40px;
 }
 
+.sidebar-tabs__content {
+	display: flex;
+	flex-direction: column;
+	gap: 8px;
+}
 .submission-message {
 	&__description {
 		color: var(--color-text-maxcontrast);