Fix lookup server connector background jobs problem

apps/lookup_server_connector/appinfo/app.php

@@ -19,13 +19,5 @@
  *
  */
 
-$dispatcher = \OC::$server->getEventDispatcher();
-
-$dispatcher->addListener('OC\AccountManager::userUpdated', function(\Symfony\Component\EventDispatcher\GenericEvent $event) {
-	/** @var \OCP\IUser $user */
-	$user = $event->getSubject();
-
-	/** @var \OCA\LookupServerConnector\UpdateLookupServer $updateLookupServer */
-	$updateLookupServer = \OC::$server->query(\OCA\LookupServerConnector\UpdateLookupServer::class);
-	$updateLookupServer->userUpdated($user);
-});
+$app = new \OCA\LookupServerConnector\AppInfo\Application();
+$app->register();

apps/lookup_server_connector/composer/composer/autoload_classmap.php

@@ -6,6 +6,7 @@
 $baseDir = $vendorDir;
 
 return array(
+    'OCA\\LookupServerConnector\\AppInfo\\Application' => $baseDir . '/../lib/AppInfo/Application.php',
     'OCA\\LookupServerConnector\\BackgroundJobs\\RetryJob' => $baseDir . '/../lib/BackgroundJobs/RetryJob.php',
     'OCA\\LookupServerConnector\\UpdateLookupServer' => $baseDir . '/../lib/UpdateLookupServer.php',
 );

apps/lookup_server_connector/composer/composer/autoload_static.php

@@ -21,6 +21,7 @@ class ComposerStaticInitLookupServerConnector
     );
 
     public static $classMap = array (
+        'OCA\\LookupServerConnector\\AppInfo\\Application' => __DIR__ . '/..' . '/../lib/AppInfo/Application.php',
         'OCA\\LookupServerConnector\\BackgroundJobs\\RetryJob' => __DIR__ . '/..' . '/../lib/BackgroundJobs/RetryJob.php',
         'OCA\\LookupServerConnector\\UpdateLookupServer' => __DIR__ . '/..' . '/../lib/UpdateLookupServer.php',
     );

apps/lookup_server_connector/lib/AppInfo/Application.php

@@ -0,0 +1,56 @@
+<?php
+declare(strict_types=1);
+/**
+ * @copyright Copyright (c) 2019 Joas Schilling <[email protected]>
+ *
+ * @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\LookupServerConnector\AppInfo;
+
+use OCA\LookupServerConnector\UpdateLookupServer;
+use OCP\AppFramework\App;
+use OCP\IUser;
+use Symfony\Component\EventDispatcher\GenericEvent;
+
+class Application extends App {
+	public function __construct () {
+		parent::__construct('lookup_server_connector');
+	}
+
+	/**
+	 * Register the different app parts
+	 */
+	public function register(): void {
+		$this->registerHooksAndEvents();
+	}
+
+	/**
+	 * Register the hooks and events
+	 */
+	public function registerHooksAndEvents(): void {
+		$dispatcher = $this->getContainer()->getServer()->getEventDispatcher();
+		$dispatcher->addListener('OC\AccountManager::userUpdated', static function(GenericEvent $event) {
+			/** @var IUser $user */
+			$user = $event->getSubject();
+
+			/** @var UpdateLookupServer $updateLookupServer */
+			$updateLookupServer = \OC::$server->query(UpdateLookupServer::class);
+			$updateLookupServer->userUpdated($user);
+		});
+
+	}
+}

apps/lookup_server_connector/lib/BackgroundJobs/RetryJob.php

@@ -1,6 +1,8 @@
 <?php
+declare(strict_types=1);
 /**
  * @copyright Copyright (c) 2016 Bjoern Schiessle <[email protected]>
+ * @copyright Copyright (c) 2019 Joas Schilling <[email protected]>
  *
  * @license GNU AGPL version 3 or any later version
  *
@@ -22,40 +24,55 @@
 namespace OCA\LookupServerConnector\BackgroundJobs;
 
 
-use OC\BackgroundJob\Job;
-use OC\BackgroundJob\JobList;
+use OC\Security\IdentityProof\Signer;
+use OCP\Accounts\IAccountManager;
+use OCP\AppFramework\Utility\ITimeFactory;
+use OCP\BackgroundJob\Job;
 use OCP\BackgroundJob\IJobList;
 use OCP\Http\Client\IClientService;
 use OCP\IConfig;
 use OCP\ILogger;
+use OCP\IUser;
+use OCP\IUserManager;
 
 class RetryJob extends Job {
 	/** @var IClientService */
 	private $clientService;
-	/** @var IJobList */
-	private $jobList;
 	/** @var string */
 	private $lookupServer;
-	/** @var int how much time should be between two, will be increased for each retry */
-	private $interval = 100;
 	/** @var IConfig */
 	private $config;
+	/** @var IUserManager */
+	private $userManager;
+	/** @var IAccountManager */
+	private $accountManager;
+	/** @var Signer */
+	private $signer;
+	/** @var int */
+	protected $retries = 0;
+	/** @var bool */
+	protected $retainJob = false;
 
 	/**
+	 * @param ITimeFactory $time
 	 * @param IClientService $clientService
-	 * @param IJobList $jobList
 	 * @param IConfig $config
+	 * @param IUserManager $userManager
+	 * @param IAccountManager $accountManager
+	 * @param Signer $signer
 	 */
-	public function __construct(IClientService $clientService,
-								IJobList $jobList,
-								IConfig $config) {
+	public function __construct(ITimeFactory $time,
+								IClientService $clientService,
+								IConfig $config,
+								IUserManager $userManager,
+								IAccountManager $accountManager,
+								Signer $signer) {
+		parent::__construct($time);
 		$this->clientService = $clientService;
-		$this->jobList = $jobList;
 		$this->config = $config;
-
-		if ($config->getSystemValue('has_internet_connection', true) === false) {
-			return;
-		}
+		$this->userManager = $userManager;
+		$this->accountManager = $accountManager;
+		$this->signer = $signer;
 
 		$this->lookupServer = $config->getSystemValue('lookup_server', 'https://lookup.nextcloud.com');
 		if (!empty($this->lookupServer)) {
@@ -67,71 +84,129 @@ public function __construct(IClientService $clientService,
 	/**
 	 * run the job, then remove it from the jobList
 	 *
-	 * @param JobList $jobList
+	 * @param IJobList $jobList
 	 * @param ILogger|null $logger
 	 */
-	public function execute($jobList, ILogger $logger = null) {
-		if ($this->shouldRun($this->argument)) {
-			parent::execute($jobList, $logger);
+	public function execute($jobList, ILogger $logger = null): void {
+		if (!isset($this->argument['userId'])) {
+			// Old background job without user id, just drop it.
 			$jobList->remove($this, $this->argument);
+			return;
+		}
+
+		$this->retries = (int) $this->config->getUserValue($this->argument['userId'], 'lookup_server_connector', 'update_retries', 0);
+
+		if ($this->shouldRemoveBackgroundJob()) {
+			$jobList->remove($this, $this->argument);
+			return;
+		}
+
+		if ($this->shouldRun()) {
+			parent::execute($jobList, $logger);
+			if (!$this->retainJob) {
+				$jobList->remove($this, $this->argument);
+			}
 		}
 	}
 
-	protected function run($argument) {
-		if ($this->killBackgroundJob((int)$argument['retryNo'])) {
+	/**
+	 * Check if we should kill the background job:
+	 *
+	 * - internet connection is disabled
+	 * - no valid lookup server URL given
+	 * - lookup server was disabled by the admin
+	 * - max retries are reached (set to 5)
+	 *
+	 * @return bool
+	 */
+	protected function shouldRemoveBackgroundJob(): bool {
+		return $this->config->getSystemValueBool('has_internet_connection', true) === false ||
+			$this->config->getSystemValueString('lookup_server', 'https://lookup.nextcloud.com') === '' ||
+			$this->config->getAppValue('files_sharing', 'lookupServerUploadEnabled', 'yes') !== 'yes' ||
+			$this->retries >= 5;
+	}
+
+	protected function shouldRun(): bool {
+		$delay = 100 * 6 ** $this->retries;
+		return ($this->time->getTime() - $this->lastRun) > $delay;
+	}
+
+	protected function run($argument): void {
+		$user = $this->userManager->get($this->argument['userId']);
+		if (!$user instanceof IUser) {
+			// User does not exist anymore
 			return;
 		}
 
+		$data = $this->getUserAccountData($user);
+		$signedData = $this->signer->sign('lookupserver', $data, $user);
 		$client = $this->clientService->newClient();
 
 		try {
-			$client->post($this->lookupServer,
-				[
-					'body' => json_encode($argument['dataArray']),
-					'timeout' => 10,
-					'connect_timeout' => 3,
-				]
+			if (count($data) === 1) {
+				// No public data, just the federation Id
+				$client->delete($this->lookupServer,
+					[
+						'body' => json_encode($signedData),
+						'timeout' => 10,
+						'connect_timeout' => 3,
+					]
+				);
+			} else {
+				$client->post($this->lookupServer,
+					[
+						'body' => json_encode($signedData),
+						'timeout' => 10,
+						'connect_timeout' => 3,
+					]
+				);
+			}
+
+			// Reset retry counter
+			$this->config->deleteUserValue(
+				$user->getUID(),
+				'lookup_server_connector',
+				'update_retries'
 			);
+
 		} catch (\Exception $e) {
-			$this->jobList->add(RetryJob::class,
-				[
-					'dataArray' => $argument['dataArray'],
-					'retryNo' => $argument['retryNo'] + 1,
-					'lastRun' => time(),
-				]
+			// An error occurred, retry later
+			$this->retainJob = true;
+			$this->config->setUserValue(
+				$user->getUID(),
+				'lookup_server_connector',
+				'update_retries',
+				$this->retries + 1
 			);
-
 		}
 	}
 
-	/**
-	 * test if it is time for the next run
-	 *
-	 * @param array $argument
-	 * @return bool
-	 */
-	protected function shouldRun($argument) {
-		$retryNo = (int)$argument['retryNo'];
-		$delay = $this->interval * 6 ** $retryNo;
-		return !isset($argument['lastRun']) || ((time() - $argument['lastRun']) > $delay);
-	}
+	protected function getUserAccountData(IUser $user): array {
+		$account = $this->accountManager->getAccount($user);
 
-	/**
-	 * check if we should kill the background job
-	 *
-	 * The lookup server should no longer be contacted if:
-	 *
-	 * - max retries are reached (set to 5)
-	 * - lookup server was disabled by the admin
-	 * - no valid lookup server URL given
-	 *
-	 * @param int $retryCount
-	 * @return bool
-	 */
-	protected function killBackgroundJob($retryCount) {
-		$maxTriesReached = $retryCount >= 5;
-		$lookupServerDisabled = $this->config->getAppValue('files_sharing', 'lookupServerUploadEnabled', 'yes') !== 'yes';
+		$publicData = [];
+		foreach ($account->getProperties() as $property) {
+			if ($property->getScope() === IAccountManager::VISIBILITY_PUBLIC) {
+				$publicData[$property->getName()] = $property->getValue();
+			}
+		}
+
+		$data = ['federationId' => $user->getCloudId()];
+		if (!empty($publicData)) {
+			$data['name'] = $publicData[IAccountManager::PROPERTY_DISPLAYNAME]['value'] ?? '';
+			$data['email'] = $publicData[IAccountManager::PROPERTY_EMAIL]['value'] ?? '';
+			$data['address'] = $publicData[IAccountManager::PROPERTY_ADDRESS]['value'] ?? '';
+			$data['website'] = $publicData[IAccountManager::PROPERTY_WEBSITE]['value'] ?? '';
+			$data['twitter'] = $publicData[IAccountManager::PROPERTY_TWITTER]['value'] ?? '';
+			$data['phone'] = $publicData[IAccountManager::PROPERTY_PHONE]['value'] ?? '';
+			$data['twitter_signature'] = $publicData[IAccountManager::PROPERTY_TWITTER]['signature'] ?? '';
+			$data['website_signature'] = $publicData[IAccountManager::PROPERTY_WEBSITE]['signature'] ?? '';
+			$data['verificationStatus'] = [
+				IAccountManager::PROPERTY_WEBSITE => $publicData[IAccountManager::PROPERTY_WEBSITE]['verified'] ?? '',
+				IAccountManager::PROPERTY_TWITTER => $publicData[IAccountManager::PROPERTY_TWITTER]['verified'] ?? '',
+			];
+		}
 
-		return $maxTriesReached || $lookupServerDisabled || empty($this->lookupServer);
+		return $data;
 	}
 }