-
-
Notifications
You must be signed in to change notification settings - Fork 4.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(contactsinteraction): allow users to disable contacts interactio…
…n addressbook This allows simple users to opt-out of the contacts interaction addressbook even if admins have the app installed. Similar to how the birthday calendar works, the functionnality can be toggled in the user's settings or by doing a DELETE on the addressbook. A new contacts personal section has been added to contain this new setting. Signed-off-by: Thomas Citharel <tcit@tcit.fr>
- Loading branch information
Showing
22 changed files
with
600 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /** | ||
| * @copyright Copyright (c) 2023 Thomas Citharel <nextcloud@tcit.fr> | ||
| * | ||
| * @author Thomas Citharel <nextcloud@tcit.fr> | ||
| * | ||
| * @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/>. | ||
| * | ||
| */ | ||
| return [ | ||
| 'ocs' => [ | ||
| ['name' => 'config#disable', 'url' => '/config/user/disable', 'verb' => 'POST'], | ||
| ], | ||
| ]; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
52 changes: 52 additions & 0 deletions
52
apps/contactsinteraction/lib/Controller/ConfigController.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| <?php | ||
| /** | ||
| * @copyright Copyright (c) 2023 Thomas Citharel <nextcloud@tcit.fr> | ||
| * | ||
| * @author Thomas Citharel <nextcloud@tcit.fr> | ||
| * | ||
| * @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\ContactsInteraction\Controller; | ||
|
|
||
| use OCA\ContactsInteraction\Db\RecentContactMapper; | ||
| use OCP\AppFramework\Controller; | ||
| use OCP\AppFramework\Http; | ||
| use OCP\AppFramework\Http\DataResponse; | ||
| use OCP\AppFramework\Http\Response; | ||
| use OCP\IConfig; | ||
| use OCP\IRequest; | ||
|
|
||
| class ConfigController extends Controller { | ||
|
|
||
| public function __construct(string $appName, IRequest $request, private IConfig $config, private RecentContactMapper $recentContactMapper, private ?string $userId) { | ||
| parent::__construct($appName, $request); | ||
| } | ||
|
|
||
| /** | ||
| * @NoAdminRequired | ||
| */ | ||
| public function disable(): Response { | ||
| if (!$this->userId) { | ||
| return new DataResponse([], Http::STATUS_UNAUTHORIZED); | ||
| } | ||
| $this->config->setUserValue($this->userId, $this->appName, 'generateContactsInteraction', 'no'); | ||
|
|
||
| $this->recentContactMapper->cleanForUser($this->userId); | ||
|
|
||
| return new DataResponse([]); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| <?php | ||
| /** | ||
| * @copyright 2023, Thomas Citharel <nextcloud@tcit.fr> | ||
| * | ||
| * @author Thomas Citharel <nextcloud@tcit.fr> | ||
| * | ||
| * @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\ContactsInteraction\DAV; | ||
|
|
||
| use OCA\ContactsInteraction\AddressBook; | ||
| use OCA\ContactsInteraction\AppInfo\Application; | ||
| use OCP\IConfig; | ||
| use Sabre\DAV\Server; | ||
| use Sabre\DAV\ServerPlugin; | ||
| use Sabre\HTTP\RequestInterface; | ||
| use Sabre\HTTP\ResponseInterface; | ||
|
|
||
| /** | ||
| * Allows users to disable the feature by deleting the addressbook | ||
| * | ||
| * @package OCA\DAV\CalDAV\BirthdayCalendar | ||
| */ | ||
| class Plugin extends ServerPlugin { | ||
|
|
||
| protected IConfig $config; | ||
| protected Server $server; | ||
|
|
||
| public function __construct(IConfig $config) { | ||
| $this->config = $config; | ||
| } | ||
|
|
||
| /** | ||
| * This method should return a list of server-features. | ||
| * | ||
| * This is for example 'versioning' and is added to the DAV: header | ||
| * in an OPTIONS response. | ||
| * | ||
| * @return string[] | ||
| */ | ||
| public function getFeatures() { | ||
| return ['nc-disable-recently-contacted']; | ||
| } | ||
|
|
||
| /** | ||
| * Returns a plugin name. | ||
| * | ||
| * Using this name other plugins will be able to access other plugins | ||
| * using Sabre\DAV\Server::getPlugin | ||
| * | ||
| * @return string | ||
| */ | ||
| public function getPluginName() { | ||
| return 'nc-disable-recently-contacted'; | ||
| } | ||
|
|
||
| /** | ||
| * This initializes the plugin. | ||
| * | ||
| * This function is called by Sabre\DAV\Server, after | ||
| * addPlugin is called. | ||
| * | ||
| * This method should set up the required event subscriptions. | ||
| * | ||
| * @param Server $server | ||
| */ | ||
| public function initialize(Server $server) { | ||
| $this->server = $server; | ||
|
|
||
| $this->server->on('method:DELETE', [$this, 'httpDelete']); | ||
| } | ||
|
|
||
| /** | ||
| * We intercept this to handle POST requests on calendar homes. | ||
| * | ||
| * @param RequestInterface $request | ||
| * @param ResponseInterface $response | ||
| * | ||
| * @return bool|void | ||
| */ | ||
| public function httpDelete(RequestInterface $request, ResponseInterface $response) { | ||
| $node = $this->server->tree->getNodeForPath($this->server->getRequestUri()); | ||
| if (!($node instanceof AddressBook)) { | ||
| return; | ||
| } | ||
|
|
||
| $principalUri = $node->getOwner(); | ||
| $userId = substr($principalUri, 17); | ||
|
|
||
| $this->config->setUserValue($userId, Application::APP_ID, 'generateContactsInteraction', 'no'); | ||
|
|
||
| $this->server->httpResponse->setStatus(204); | ||
|
|
||
| return false; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| <?php | ||
| /** | ||
| * @copyright Copyright (c) 2023 Thomas Citharel <nextcloud@tcit.fr> | ||
| * | ||
| * @author Thomas Citharel <nextcloud@tcit.fr> | ||
| * | ||
| * @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\ContactsInteraction\Settings; | ||
|
|
||
| use OCA\ContactsInteraction\AppInfo\Application; | ||
| use OCP\AppFramework\Http\TemplateResponse; | ||
| use OCP\AppFramework\Services\IInitialState; | ||
| use OCP\IConfig; | ||
| use OCP\Settings\ISettings; | ||
| use OCP\Util; | ||
|
|
||
| class Personal implements ISettings { | ||
| public function __construct(private IInitialState $initialState, private IConfig $config, private ?string $userId) { } | ||
|
|
||
| public function getForm(): TemplateResponse { | ||
| $this->initialState->provideInitialState('generateContactsInteraction', $this->config->getUserValue($this->userId, Application::APP_ID, 'generateContactsInteraction', 'yes') === 'yes'); | ||
| Util::addScript(Application::APP_ID, 'settings-personal'); | ||
| return new TemplateResponse(Application::APP_ID, 'personal'); | ||
| } | ||
|
|
||
| public function getSection(): string { | ||
| return 'contacts'; | ||
| } | ||
|
|
||
| /** | ||
| * @psalm-return 40 | ||
| */ | ||
| public function getPriority(): int { | ||
| return 40; | ||
| } | ||
| } |
Oops, something went wrong.