Merge pull request #140 from julien-nc/fix/139/autoexport-deleted-users

Fix autoexport when some sessions are owned by deleted users

Author: julien-nc

lib/AppInfo/Application.php

@@ -12,12 +12,14 @@
 
 namespace OCA\PhoneTrack\AppInfo;
 
+use OCA\PhoneTrack\Listener\UserDeletedListener;
 use OCA\PhoneTrack\Notification\Notifier;
 use OCP\AppFramework\App;
 use OCP\AppFramework\Bootstrap\IBootContext;
 use OCP\AppFramework\Bootstrap\IBootstrap;
 
 use OCP\AppFramework\Bootstrap\IRegistrationContext;
+use OCP\User\Events\UserDeletedEvent;
 
 class Application extends App implements IBootstrap {
 
@@ -35,6 +37,7 @@ public function __construct(array $urlParams = []) {
 
 	public function register(IRegistrationContext $context): void {
 		$context->registerNotifierService(Notifier::class);
+		$context->registerEventListener(UserDeletedEvent::class, UserDeletedListener::class);
 	}
 
 	public function boot(IBootContext $context): void {

lib/Command/AutoExport.php

@@ -31,7 +31,9 @@ protected function configure() {
 	}
 
 	protected function execute(InputInterface $input, OutputInterface $output) {
-		$this->sessionService->cronAutoExport();
+		foreach ($this->sessionService->cronAutoExport() as $message) {
+			$output->writeln($message);
+		}
 		return 0;
 	}
 }

lib/Cron/AutoExport.php

@@ -26,6 +26,6 @@ public function __construct(
 	}
 
 	protected function run($argument): void {
-		$this->sessionService->cronAutoExport();
+		iterator_to_array($this->sessionService->cronAutoExport());
 	}
 }

lib/Listener/UserDeletedListener.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OCA\PhoneTrack\Listener;
+
+use OCA\PhoneTrack\Service\SessionService;
+use OCP\EventDispatcher\Event;
+use OCP\EventDispatcher\IEventListener;
+use OCP\User\Events\UserDeletedEvent;
+
+/**
+ * @template-implements IEventListener<UserDeletedEvent>
+ */
+class UserDeletedListener implements IEventListener {
+	public function __construct(
+		private SessionService $sessionService,
+	) {
+	}
+
+	public function handle(Event $event): void {
+		if (!($event instanceof UserDeletedEvent)) {
+			return;
+		}
+
+		// cleanup user data
+		$this->sessionService->cleanupUser($event->getUser()->getUID());
+	}
+}

lib/Service/SessionService.php

@@ -141,7 +141,7 @@ private function cronAutoPurge() {
 	 *
 	 * export sessions
 	 */
-	public function cronAutoExport() {
+	public function cronAutoExport(): \Generator {
 		$dtz = ini_get('date.timezone');
 		if ($dtz === '') {
 			$dtz = 'UTC';
@@ -223,10 +223,24 @@ public function cronAutoExport() {
 		$phonetrackUserIds = $this->sessionMapper->getUserIds();
 
 		foreach ($phonetrackUserIds as $userId) {
+			$userSessions = $this->sessionMapper->findByUser($userId);
+			$candidateUserSessions = array_filter($userSessions, static function (Session $session) {
+				return $session->getAutoexport() !== 'no';
+			});
+			$candidateUserSessions = array_values($candidateUserSessions);
+			// if there is no session with autoexport enabled: skip this user
+			if (count($candidateUserSessions) === 0) {
+				continue;
+			}
+
+			// if the user does not exist: skip this this user
+			if (!$this->userManager->userExists($userId)) {
+				continue;
+			}
+
 			$userFolder = $this->root->getUserFolder($userId);
-			$sessions = $this->sessionMapper->findByUser($userId);
 
-			foreach ($sessions as $session) {
+			foreach ($candidateUserSessions as $session) {
 				$dbname = $session->getName();
 				$dbtoken = $session->getToken();
 				$dbexportType = $session->getAutoexport();
@@ -248,14 +262,22 @@ public function cronAutoExport() {
 					$rel_path = str_replace($userFolder->getPath(), '', $dir->getPath());
 					$exportPath = $rel_path . '/' . $exportName;
 					if (!$dir->nodeExists($exportName)) {
-						$this->exportSession($dbname, $dbtoken, $exportPath, $userId, $filters);
+						[$done, $warning] = $this->exportSession($dbname, $dbtoken, $exportPath, $userId, $filters);
+						if ($warning === 1) {
+							yield "Not exporting session $dbname of $userId in '$exportPath', no points";
+						} else {
+							yield "Exporting session $dbname of $userId in '$exportPath'";
+						}
+					} else {
+						yield "Cannot export session $dbname of $userId in '$exportPath', file already exists";
 					}
 				}
 			}
 		}
 		// we run the auto purge method AFTER the auto export
 		// to avoid deleting data before it has been eventually exported
 		$this->cronAutoPurge();
+		return [];
 	}
 
 	/**
@@ -298,7 +320,7 @@ public function exportDevice(Device $device, string $userId, string $target): vo
 		$file->touch();
 	}
 
-	public function exportSession(string $name, string $token, string $target, string $username = '', ?array $filters = null) {
+	public function exportSession(string $name, string $token, string $target, string $username = '', ?array $filters = null): array {
 		date_default_timezone_set('UTC');
 		$done = false;
 		$warning = 0;
@@ -1191,4 +1213,11 @@ public function deleteSession(Session $session): void {
 		}
 		$this->sessionMapper->deleteSession($session->getUser(), $session->getId());
 	}
+
+	public function cleanupUser(string $userId): void {
+		$sessions = $this->sessionMapper->findByUser($userId);
+		foreach ($sessions as $session) {
+			$this->deleteSession($session);
+		}
+	}
 }

tests/php/controller/OldPageControllerTest.php

@@ -755,7 +755,7 @@ public function testPage() {
 		$pointListBeforePurge = $respSession[$token][$deviceid];
 		$this->assertTrue(count($pointListBeforePurge) > 0);
 
-		$this->sessionService->cronAutoExport();
+		iterator_to_array($this->sessionService->cronAutoExport());
 
 		// check number of points
 		$sessions = [[$token, [$deviceid => 400], null]];
@@ -774,7 +774,7 @@ public function testPage() {
 		$search[0]->delete();
 		$resp = $this->pageController->setSessionAutoExport($token, 'weekly');
 		// do it again to test when export dir already exists and test weekly
-		$this->sessionService->cronAutoExport();
+		iterator_to_array($this->sessionService->cronAutoExport());
 		$search = $userFolder->get('/autoex')->search('.gpx');
 		$this->assertEquals(count($search), 1);