[WIP] feat: default contact

appinfo/routes.php

@@ -15,5 +15,7 @@
 		['name' => 'social_api#set_app_config',	 'url' => '/api/v1/social/config/global/{key}', 'verb' => 'PUT'],
 		['name' => 'social_api#set_user_config', 'url' => '/api/v1/social/config/user/{key}', 'verb' => 'PUT'],
 		['name' => 'social_api#get_user_config', 'url' => '/api/v1/social/config/user/{key}', 'verb' => 'GET'],
+		['name' => 'default_contact#set_app_config', 'url' => '/api/defaultcontact/config', 'verb' => 'PUT'],
+		['name' => 'default_contact#set_default_contact', 'url' => '/api/defaultcontact/contact', 'verb' => 'PUT'],
 	]
 ];

lib/AppInfo/Application.php

@@ -22,6 +22,7 @@ class Application extends App implements IBootstrap {
 
 	public const AVAIL_SETTINGS = [
 		'allowSocialSync' => 'yes',
+		'enableDefaultContact' => 'yes',
 	];
 
 	public function __construct() {

lib/Controller/DefaultContactController.php

@@ -0,0 +1,91 @@
+<?php
+/**
+ * SPDX-FileCopyrightText: 2020 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Contacts\Controller;
+
+use OCA\Contacts\AppInfo\Application;
+use OCP\App\IAppManager;
+use OCP\AppFramework\ApiController;
+use OCP\AppFramework\Http;
+use OCP\AppFramework\Http\JSONResponse;
+use OCP\Files\IAppData;
+use OCP\Files\NotFoundException;
+use OCP\IConfig;
+use OCP\IRequest;
+
+class DefaultContactController extends ApiController {
+
+	public function __construct(
+		IRequest $request,
+		private IConfig $config,
+		private IAppData $appData,
+		private IAppManager $appManager,
+	) {
+		parent::__construct(Application::APP_ID, $request);
+	}
+
+
+	/**
+	 * update appconfig (admin setting)
+	 *
+	 * @param string allow the value to set
+	 *
+	 * @return JSONResponse an empty JSONResponse with respective http status code
+	 */
+	public function setAppConfig($allow) {
+		$key = 'enableDefaultContact';
+		if ($allow === 'yes' && !$this->defaultContactExists()) {
+			$this->setInitialDefaultContact();
+		}
+		$this->config->setAppValue(Application::APP_ID, $key, $allow);
+		return new JSONResponse([], Http::STATUS_OK);
+	}
+
+	public function setDefaultContact($contactData) {
+		if (!$this->config->getAppValue(Application::APP_ID, 'enableDefaultContact', 'yes')) {
+			return new JSONResponse([], Http::STATUS_FORBIDDEN);
+		}
+		try {
+			$folder = $this->appData->getFolder('defaultContact');
+		} catch (NotFoundException $e) {
+			$folder = $this->appData->newFolder('defaultContact');
+		}
+		$file = (!$folder->fileExists('defaultContact.vcf')) ? $folder->newFile('defaultContact.vcf') : $folder->getFile('defaultContact.vcf');
+		$file->putContent($contactData);
+		return new JSONResponse([], Http::STATUS_OK);
+	}
+
+	private function setInitialDefaultContact() {
+		$cardData = 'BEGIN:VCARD' . PHP_EOL .
+		'VERSION:3.0' . PHP_EOL .
+		'PRODID:-//Nextcloud Contacts v' . $this->appManager->getAppVersion('contacts') . PHP_EOL .
+		'UID: janeDoe' . PHP_EOL .
+		'FN:Jane Doe' . PHP_EOL .
+		'ADR;TYPE=HOME:;;123 Street Street;City;State;;Country' . PHP_EOL .
+		'EMAIL;TYPE=WORK:[email protected]' . PHP_EOL .
+		'TEL;TYPE=HOME,VOICE:+999999999999' . PHP_EOL .
+		'TITLE:Manager' . PHP_EOL .
+		'ORG:Company' . PHP_EOL .
+		'BDAY;VALUE=DATE:20000101' . PHP_EOL .
+		'URL;VALUE=URI:https://example.com/' . PHP_EOL .
+		'REV;VALUE=DATE-AND-OR-TIME:20241227T144820Z' . PHP_EOL .
+		'END:VCARD';
+		$folder = $this->appData->getFolder('defaultContact');
+		$file = $folder->newFile('defaultContact.vcf');
+		$file->putContent($cardData);
+	}
+
+	private function defaultContactExists(): bool {
+		try {
+			$folder = $this->appData->getFolder('defaultContact');
+		} catch (NotFoundException $e) {
+			$this->appData->newFolder('defaultContact');
+			return false;
+		}
+		return $folder->fileExists('defaultContact.vcf');
+	}
+
+}

lib/Controller/PageController.php

@@ -52,6 +52,8 @@ public function index(): TemplateResponse {
 		$supportedNetworks = $this->socialApiService->getSupportedNetworks();
 		// allow users to retrieve avatars from social networks (default: yes)
 		$syncAllowedByAdmin = $this->config->getAppValue(Application::APP_ID, 'allowSocialSync', 'yes');
+		// add a default contact to the user's address book on first login (default: yes)
+		$enableDefaultContact = $this->config->getAppValue(Application::APP_ID, 'enableDefaultContact', 'yes');
 		// automated background syncs for social avatars (default: no)
 		$bgSyncEnabledByUser = $this->config->getUserValue($userId, Application::APP_ID, 'enableSocialSync', 'no');
 
@@ -72,6 +74,7 @@ public function index(): TemplateResponse {
 		$this->initialStateService->provideInitialState(Application::APP_ID, 'defaultProfile', $defaultProfile);
 		$this->initialStateService->provideInitialState(Application::APP_ID, 'supportedNetworks', $supportedNetworks);
 		$this->initialStateService->provideInitialState(Application::APP_ID, 'allowSocialSync', $syncAllowedByAdmin);
+		$this->initialStateService->provideInitialState(Application::APP_ID, 'enableDefaultContact', $enableDefaultContact);
 		$this->initialStateService->provideInitialState(Application::APP_ID, 'enableSocialSync', $bgSyncEnabledByUser);
 		$this->initialStateService->provideInitialState(Application::APP_ID, 'isContactsInteractionEnabled', $isContactsInteractionEnabled);
 		$this->initialStateService->provideInitialState(Application::APP_ID, 'isCirclesEnabled', $isCirclesEnabled && $isCircleVersionCompatible);

src/components/AdminSettings.vue

@@ -11,29 +11,117 @@
 				v-model="allowSocialSync"
 				type="checkbox"
 				class="checkbox"
-				@change="updateSetting('allowSocialSync')">
+				@change="updateAllowSocialSync">
 			<label for="allow-social-sync">{{ t('contacts', 'Allow updating avatars from social media') }}</label>
 		</p>
+		<p>
+			<input id="enable-default-contact"
+				v-model="enableDefaultContact"
+				type="checkbox"
+				class="checkbox"
+				@change="updateEnableDefaultContact">
+			<label for="enable-default-contact"> {{ t('mail',"Default contact is added to the user's own address book on user's first login.") }} </label>
+			<NcButton v-if="enableDefaultContact"
+				class="import-button"
+				type="primary"
+				@click="toggleModal">
+				<template #icon>
+					<IconUpload :size="20" />
+				</template>
+				{{ t('contacts', 'Import contact') }}
+			</NcButton>
+			<NcDialog :open.sync="isModalOpen"
+				:name="t('contacts', 'Import contacts')"
+				:buttons="buttons">
+				<div>
+					<p>{{ t('contacts', 'Importing a new .vcf file will delete the existing default contact and replace it with the new one. Do you want to continue?') }}</p>
+					<input id="contact-import"
+						ref="contact-import-input"
+						:disabled="loading"
+						type="file"
+						class="hidden-visually"
+						@change="processFile">
+				</div>
+			</NcDialog>
+		</p>
 	</div>
 </template>
 
 <script>
 import axios from '@nextcloud/axios'
 import { generateUrl } from '@nextcloud/router'
 import { loadState } from '@nextcloud/initial-state'
+import { NcDialog, NcButton } from '@nextcloud/vue'
+import { showSuccess } from '@nextcloud/dialogs'
+import IconUpload from 'vue-material-design-icons/Upload.vue'
+import IconCancel from '@mdi/svg/svg/cancel.svg'
+import IconCheck from '@mdi/svg/svg/check.svg'
+
 export default {
 	name: 'AdminSettings',
+	components: {
+		NcDialog,
+		NcButton,
+		IconUpload,
+	},
 	data() {
 		return {
 			allowSocialSync: loadState('contacts', 'allowSocialSync') === 'yes',
+			enableDefaultContact: loadState('contacts', 'enableDefaultContact') === 'yes',
+			isModalOpen: false,
+			loading: false,
+			buttons: [
+				{
+					label: t('contacts', 'Cancel'),
+					icon: IconCancel,
+					callback: () => { this.isModalOpen = false },
+				},
+				{
+					label: t('contacts', 'Import'),
+					type: 'primary',
+					icon: IconCheck,
+					callback: () => { this.clickImportInput() },
+				},
+			],
 		}
 	},
 	methods: {
-		updateSetting(setting) {
-			axios.put(generateUrl('apps/contacts/api/v1/social/config/global/' + setting), {
-				allow: this[setting] ? 'yes' : 'no',
+		updateAllowSocialSync() {
+			axios.put(generateUrl('apps/contacts/api/v1/social/config/global/allowSocialSync'), {
+				allow: this.allowSocialSync ? 'yes' : 'no',
+			})
+		},
+		updateEnableDefaultContact() {
+			axios.put(generateUrl('apps/contacts/api/defaultcontact/config'), {
+				allow: this.enableDefaultContact ? 'yes' : 'no',
 			})
 		},
+		toggleModal() {
+			this.isModalOpen = !this.isModalOpen
+		},
+		clickImportInput() {
+			this.$refs['contact-import-input'].click()
+		},
+
+		processFile(event) {
+			this.loading = true
+
+			const file = event.target.files[0]
+			const reader = new FileReader()
+
+			reader.onload = () => {
+				this.isModalOpen = false
+				axios.put(generateUrl('/apps/contacts/api/defaultcontact/contact'), { contactData: reader.result })
+				event.target.value = ''
+			}
+			reader.readAsText(file)
+			showSuccess(this.t('contacts', 'Contact imported successfully'))
+		},
 	},
 }
 </script>
+<style lang="scss" scoped>
+.import-button {
+	margin-top: 1rem;
+}
+</style>

src/models/contact.js

@@ -214,7 +214,7 @@ export default class Contact {
 	 *
 	 * @readonly
 	 * @memberof Contact
- 	 */
+	 */
 	get hasPhoto() {
 		return this.dav && this.dav.hasphoto
 	}

src/services/defaultContactService.js

@@ -0,0 +1,14 @@
+/**
+ * SPDX-FileCopyrightText: 2018 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+import axios from '@nextcloud/axios'
+import { generateOcsUrl } from '@nextcloud/router'
+
+export const setDefaultContact = async function(contactId) {
+	const request = await axios.post(generateOcsUrl('apps/contacts/api/v1/default'), {
+		contactId,
+	})
+	return request.data
+}