get contact pictures from social networks

appinfo/info.xml

@@ -41,4 +41,8 @@
 	<contactsmenu>
 		<provider>OCA\Contacts\ContactsMenu\Providers\DetailsProvider</provider>
 	</contactsmenu>
+
+	<settings>
+		<admin>OCA\Contacts\Settings\AdminSettings</admin>
+	</settings>
 </info>

appinfo/routes.php

@@ -25,6 +25,8 @@
 	'routes' => [
 		['name' => 'page#index', 'url' => '/', 'verb' => 'GET'],
 		['name' => 'page#index', 'url' => '/{group}', 'verb' => 'GET', 'postfix' => 'group'],
-		['name' => 'page#index', 'url' => '/{group}/{contact}', 'verb' => 'GET', 'postfix' => 'group.contact']
+		['name' => 'page#index', 'url' => '/{group}/{contact}', 'verb' => 'GET', 'postfix' => 'group.contact'],
+		['name' => 'social_api#update_contact', 'url' => '/api/v1/social/avatar/{network}/{addressbookId}/{contactId}', 'verb' => 'GET'],
+		['name' => 'social_api#set_app_config', 'url' => '/api/v1/social/config/{key}', 'verb' => 'POST'],
 	]
 ];

css/icons.scss

@@ -30,6 +30,14 @@
 @include icon-black-white('no-calendar', 'contacts', 1);
 @include icon-black-white('language', 'contacts', 2);
 @include icon-black-white('clone', 'contacts', 2);
+@include icon-black-white('sync', 'contacts', 2);
+
+// social network icons:
+@include icon-black-white('facebook', 'contacts', 2);
+@include icon-black-white('instagram', 'contacts', 2);
+@include icon-black-white('mastodon', 'contacts', 2);
+@include icon-black-white('tumblr', 'contacts', 2);
+@include icon-black-white('twitter', 'contacts', 2);
 
 .icon-up-force-white {
 	// using #fffffe to trick the accessibility dark theme icon invert

lib/AppInfo/Application.php

@@ -33,6 +33,10 @@ class Application extends App {
 	public function __construct() {
 		parent::__construct(self::APP_ID);
 	}
+
+	public const AVAIL_SETTINGS = [
+		'allowSocialSync' => 'yes',
+	];
 
 	public function register() {
 		$server = $this->getContainer()->getServer();

lib/Controller/PageController.php

@@ -30,6 +30,7 @@
 use OCP\IRequest;
 use OCP\L10N\IFactory;
 use OCP\Util;
+use OCA\Contacts\Service\SocialApiService;
 
 class PageController extends Controller {
 
@@ -44,17 +45,22 @@ class PageController extends Controller {
 	/** @var IFactory */
 	private $languageFactory;
 
+	/** @var SocialApiService */
+	private  $socialApiService;
+
 	public function __construct(string $appName,
-								IRequest $request,
-								IConfig $config,
-								IInitialStateService $initialStateService,
-								IFactory $languageFactory) {
+					IRequest $request,
+					IConfig $config,
+					IInitialStateService $initialStateService,
+					IFactory $languageFactory,
+					SocialApiService $socialApiService) {
 		parent::__construct($appName, $request);
 
 		$this->appName = $appName;
 		$this->config = $config;
 		$this->initialStateService = $initialStateService;
 		$this->languageFactory = $languageFactory;
+		$this->socialApiService = $socialApiService;
 	}
 
 	/**
@@ -66,10 +72,12 @@ public function __construct(string $appName,
 	public function index(): TemplateResponse {
 		$locales = $this->languageFactory->findAvailableLocales();
 		$defaultProfile = $this->config->getAppValue($this->appName, 'defaultProfile', 'HOME');
+		$supportedNetworks = $this->socialApiService->getSupportedNetworks();
 
 		$this->initialStateService->provideInitialState($this->appName, 'locales', $locales);
 		$this->initialStateService->provideInitialState($this->appName, 'defaultProfile', $defaultProfile);
-
+		$this->initialStateService->provideInitialState($this->appName, 'supportedNetworks', $supportedNetworks);
+
 		Util::addScript($this->appName, 'contacts');
 		Util::addStyle($this->appName, 'contacts');
 

lib/Controller/SocialApiController.php

@@ -0,0 +1,97 @@
+<?php
+/**
+ * @copyright Copyright (c) 2020 Matthias Heinisch <nextcloud@matthiasheinisch.de>
+ *
+ * @author Matthias Heinisch <nextcloud@matthiasheinisch.de>
+ *
+ * @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\Contacts\Controller;
+
+use OCP\IConfig;
+use OCP\AppFramework\ApiController;
+use OCP\AppFramework\Http;
+use OCP\AppFramework\Http\JSONResponse;
+use OCP\IRequest;
+
+use OCA\Contacts\Service\SocialApiService;
+use OCA\Contacts\AppInfo\Application;
+
+
+class SocialApiController extends ApiController {
+
+	/** @var IConfig */
+	private  $config;
+	/** @var SocialApiService */
+	private  $socialApiService;
+
+	public function __construct(
+					IRequest $request,
+					IConfig $config,
+					SocialApiService $socialApiService) {
+		parent::__construct(Application::APP_ID, $request);
+
+		$this->config = $config;
+		$this->socialApiService = $socialApiService;
+	}
+
+
+	/**
+	 * update appconfig (admin setting)
+	 *
+	 * @param {String} key the identifier to change
+	 * @param {String} allow the value to set
+	 *
+	 * @returns {JSONResponse} an empty JSONResponse with respective http status code
+	 */
+	public function setAppConfig($key, $allow) {
+		$permittedKeys = ['allowSocialSync'];
+		if (!in_array($key, $permittedKeys)) {
+			return new JSONResponse([], Http::STATUS_FORBIDDEN);
+		}
+		$this->config->setAppValue(Application::APP_ID, $key, $allow);
+		return new JSONResponse([], Http::STATUS_OK);
+	}
+
+	/**
+	 * @NoAdminRequired
+	 *
+	 * returns an array of supported social networks
+	 *
+	 * @returns {array} array of the supported social networks
+	 */
+	public function getSupportedNetworks() : array {
+		return $this->socialApiService->getSupportedNetworks();
+	}
+
+
+	/**
+	 * @NoAdminRequired
+	 *
+	 * Retrieves social profile data for a contact and updates the entry
+	 *
+	 * @param {String} addressbookId the addressbook identifier
+	 * @param {String} contactId the contact identifier
+	 * @param {String} network the social network to use (if unkown: take first match)
+	 *
+	 * @returns {JSONResponse} an empty JSONResponse with respective http status code
+	 */
+	public function updateContact(string $addressbookId, string $contactId, string $network) : JSONResponse {
+		return $this->socialApiService->updateContact($addressbookId, $contactId, $network);
+	}
+}

lib/Service/Social/CompositeSocialProvider.php

@@ -0,0 +1,97 @@
+<?php
+/**
+ * @copyright 2020 Matthias Heinisch <nextcloud@matthiasheinisch.de>
+ *
+ * @author Matthias Heinisch <nextcloud@matthiasheinisch.de>
+ *
+ * @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\Contacts\Service\Social;
+
+/**
+ * Composition of all social providers for easier usage
+ */
+class CompositeSocialProvider {
+
+	/** @var ISocialProvider[] */
+	private $providers;
+
+	public function __construct(InstagramProvider $instagramProvider,
+					MastodonProvider $mastodonProvider,
+					FacebookProvider $facebookProvider,
+					TwitterProvider $twitterProvider,
+					TumblrProvider $tumblrProvider) {
+
+		// This determines the priority of known providers
+		$this->providers = [
+			'instagram' => $instagramProvider,
+			'mastodon'  => $mastodonProvider,
+			'twitter'   => $twitterProvider,
+			'facebook'  => $facebookProvider,
+			'tumblr'    => $tumblrProvider,
+		];
+	}
+
+	/**
+	 * returns an array of supported social providers
+	 *
+	 * @returns String[] array of the supported social networks
+	 */
+	public function getSupportedNetworks() : array {
+		return array_keys($this->providers);
+	}
+
+
+	/**
+	 * generate download url for a social entry
+	 *
+	 * @param array socialEntries all social data from the contact
+	 * @param String network the choice which network to use (fallback: take first available)
+	 *
+	 * @returns String the url to the requested information or null in case of errors
+	 */
+	public function getSocialConnector(array $socialEntries, string $network) : ?string {
+
+		$connector = null;
+		$selection = $this->providers;
+		// check if dedicated network selected
+		if (isset($this->providers[$network])) {
+			$selection = [$network => $this->providers[$network]];
+		}
+
+		// check selected providers in order
+		foreach($selection as $type => $socialProvider) {
+
+			// search for this network in user's profile
+			foreach ($socialEntries as $socialEntry) {
+
+				if (strtolower($type) === strtolower($socialEntry['type'])) {
+					$profileId = $socialProvider->cleanupId($socialEntry['value']);
+					if (!is_null($profileId)) {
+						$connector = $socialProvider->getImageUrl($profileId);
+					}
+					break;
+				}
+			}
+			if ($connector) {
+				break;
+			}
+		}
+		return ($connector);
+	}
+}

lib/Service/Social/FacebookProvider.php

@@ -0,0 +1,55 @@
+<?php
+/**
+ * @copyright Copyright (c) 2020 Matthias Heinisch <nextcloud@matthiasheinisch.de>
+ *
+ * @author Matthias Heinisch <nextcloud@matthiasheinisch.de>
+ *
+ * @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\Contacts\Service\Social;
+
+class FacebookProvider implements ISocialProvider {
+
+	public function __construct() {
+	}
+
+	/**
+	 * Returns the profile-id
+	 *
+	 * @param {string} the value from the contact's x-socialprofile
+	 *
+	 * @return string
+	 */
+	public function cleanupId(string $candidate):?string {
+		return basename($candidate);
+	}
+
+	/**
+	 * Returns the profile-picture url
+	 *
+	 * @param {string} profileId the profile-id
+	 *
+	 * @return string|null
+	 */
+	public function getImageUrl(string $profileId):?string {
+		$recipe = 'https://graph.facebook.com/{socialId}/picture?width=720';
+		$connector = str_replace("{socialId}", $profileId, $recipe);
+		return $connector;
+	}
+
+}