94: Hook for user deletion and minor fixes

janis91 · Jul 23, 2017 · 0a6d1ed · 0a6d1ed
1 parent 790a9f4
commit 0a6d1ed
Show file tree

Hide file tree

Showing 17 changed files with 211 additions and 35 deletions.
diff --git a/appinfo/app.php b/appinfo/app.php
@@ -11,4 +11,5 @@
 namespace OCA\Ocr\AppInfo;
 
 $app = new \OCA\Ocr\AppInfo\Application();
-$app->registerPersonal();
+$app->registerPersonal();
+$app->registerHooks();
diff --git a/js/dist/ocradmin.js b/js/dist/ocradmin.js
@@ -192,10 +192,10 @@ return /******/ (function(modules) { // webpackBootstrap
 	    };
 	    Controller.prototype.displayMessage = function (message, error) {
 	        if (error) {
-	            this.notification.showHtml("<div>" + message + "</div>", { timeout: 10, type: 'error' });
+	            this.notification.showHtml("<div>" + t('ocr', 'OCR') + ": " + message + "</div>", { timeout: 10, type: 'error' });
 	        }
 	        else {
-	            this.notification.showHtml("<div>" + message + "</div>", { timeout: 5 });
+	            this.notification.showHtml("<div>" + t('ocr', 'OCR') + ": " + message + "</div>", { timeout: 5 });
 	        }
 	    };
 	    Controller.prototype.getLanguages = function () {

diff --git a/js/dist/ocrapp.js b/js/dist/ocrapp.js
@@ -509,7 +509,7 @@ return /******/ (function(modules) { // webpackBootstrap
 	        this._notificationRow = undefined;
 	    }
 	    View.prototype.displayError = function (message) {
-	        this.notification.showHtml("<div>" + message + "</div>", { timeout: 10, type: 'error' });
+	        this.notification.showHtml("<div>" + t('ocr', 'OCR') + ": " + message + "</div>", { timeout: 10, type: 'error' });
 	    };
 	    View.prototype.renderDropdown = function (languages) {
 	        this.destroyDropdown();

diff --git a/js/dist/ocrpersonal.js b/js/dist/ocrpersonal.js
@@ -132,10 +132,10 @@ return /******/ (function(modules) { // webpackBootstrap
 	    }
 	    View.prototype.displayMessage = function (message, error) {
 	        if (error) {
-	            this.notification.showHtml("<div>" + message + "</div>", { timeout: 10, type: 'error' });
+	            this.notification.showHtml("<div>" + t('ocr', 'OCR') + ": " + message + "</div>", { timeout: 10, type: 'error' });
 	        }
 	        else {
-	            this.notification.showHtml("<div>" + message + "</div>", { timeout: 10 });
+	            this.notification.showHtml("<div>" + t('ocr', 'OCR') + ": " + message + "</div>", { timeout: 10 });
 	        }
 	    };
 	    View.prototype.render = function (jobs) {

diff --git a/js/src/admin/controller/controller.spec.ts b/js/src/admin/controller/controller.spec.ts
@@ -52,15 +52,15 @@ describe('For the controller', () => {
 
             cut.displayMessage(message, true);
 
-            expect(notificationMock.showHtml).toHaveBeenCalledWith(`<div>${message}</div>`, { timeout: 10, type: 'error' });
+            expect(notificationMock.showHtml).toHaveBeenCalledWith(`<div>OCR: ${message}</div>`, { timeout: 10, type: 'error' });
         });
 
         it('should display a normal message.', () => {
             const message = 'test';
 
             cut.displayMessage(message, false);
 
-            expect(notificationMock.showHtml).toHaveBeenCalledWith(`<div>${message}</div>`, { timeout: 5 });
+            expect(notificationMock.showHtml).toHaveBeenCalledWith(`<div>OCR: ${message}</div>`, { timeout: 5 });
         });
     });
 

diff --git a/js/src/admin/controller/controller.ts b/js/src/admin/controller/controller.ts
@@ -89,9 +89,9 @@ export class Controller {
      */
     public displayMessage(message: string, error: boolean): void {
         if (error) {
-            this.notification.showHtml(`<div>${message}</div>`, { timeout: 10, type: 'error' });
+            this.notification.showHtml(`<div>${this.t('ocr', 'OCR')}: ${message}</div>`, { timeout: 10, type: 'error' });
         } else {
-            this.notification.showHtml(`<div>${message}</div>`, { timeout: 5 });
+            this.notification.showHtml(`<div>${this.t('ocr', 'OCR')}: ${message}</div>`, { timeout: 5 });
         }
     }
 

diff --git a/js/src/app/view/view.spec.ts b/js/src/app/view/view.spec.ts
@@ -24,7 +24,7 @@ describe('For the view', () => {
 
             cut.displayError(message);
 
-            expect(notificationMock.showHtml).toHaveBeenCalledWith(`<div>${message}</div>`, { timeout: 10, type: 'error' });
+            expect(notificationMock.showHtml).toHaveBeenCalledWith(`<div>OCR: ${message}</div>`, { timeout: 10, type: 'error' });
         });
     });
 

diff --git a/js/src/app/view/view.ts b/js/src/app/view/view.ts
@@ -32,7 +32,7 @@ export class View {
      * @param message The message to display.
      */
     public displayError(message: string): void {
-        this.notification.showHtml(`<div>${message}</div>`, { timeout: 10, type: 'error' });
+        this.notification.showHtml(`<div>${this.t('ocr', 'OCR')}: ${message}</div>`, { timeout: 10, type: 'error' });
     }
 
     /**

diff --git a/js/src/personal/view/view.spec.ts b/js/src/personal/view/view.spec.ts
@@ -25,15 +25,15 @@ describe('For the view', () => {
 
             cut.displayMessage(message, false);
 
-            expect(notificationMock.showHtml).toHaveBeenCalledWith(`<div>${message}</div>`, { timeout: 10 });
+            expect(notificationMock.showHtml).toHaveBeenCalledWith(`<div>OCR: ${message}</div>`, { timeout: 10 });
         });
 
         it('should display an error message.', () => {
             const message = 'test';
 
             cut.displayMessage(message, true);
 
-            expect(notificationMock.showHtml).toHaveBeenCalledWith(`<div>${message}</div>`, { timeout: 10, type: 'error' });
+            expect(notificationMock.showHtml).toHaveBeenCalledWith(`<div>OCR: ${message}</div>`, { timeout: 10, type: 'error' });
         });
     });
 

diff --git a/js/src/personal/view/view.ts b/js/src/personal/view/view.ts
@@ -25,9 +25,9 @@ export class View {
      */
     public displayMessage(message: string, error: boolean): void {
         if (error) {
-            this.notification.showHtml(`<div>${message}</div>`, { timeout: 10, type: 'error' });
+            this.notification.showHtml(`<div>${this.t('ocr', 'OCR')}: ${message}</div>`, { timeout: 10, type: 'error' });
         } else {
-            this.notification.showHtml(`<div>${message}</div>`, { timeout: 10 });
+            this.notification.showHtml(`<div>${this.t('ocr', 'OCR')}: ${message}</div>`, { timeout: 10 });
         }
     }
 

diff --git a/lib/AppInfo/Application.php b/lib/AppInfo/Application.php
@@ -29,6 +29,7 @@
 use OCA\Ocr\Util\PHPUtil;
 use OCA\Ocr\Util\FileUtil;
 use OCA\Ocr\Util\RedisUtil;
+use OCA\Ocr\Hooks\UserHooks;
 
 
 /**
@@ -85,7 +86,7 @@ function (IContainer $c) {
         /**
          * Register the RedisUtil
          */
-        $container->registerService('RedisUtil',
+        $container->registerService('RedisUtil', 
                 function (IContainer $c) {
                     /** @var \OC\Server $server */
                     $server = $c->query('ServerContainer');
@@ -132,7 +133,8 @@ function (IContainer $c) {
                 function (IAppContainer $c) {
                     /** @var \OC\Server $server */
                     $server = $c->query('ServerContainer');
-                    return new AppConfigService($server->getConfig(), $server->getL10N('ocr'), $c->query('RedisUtil'), $server->getLogger());
+                    return new AppConfigService($server->getConfig(), $server->getL10N('ocr'), $c->query('RedisUtil'), 
+                            $server->getLogger());
                 });
         /**
          * Register the Job Service
@@ -162,9 +164,9 @@ function (IAppContainer $c) {
                     /** @var \OC\Server $server */
                     $server = $c->query('ServerContainer');
                     return new JobService($server->getL10N('ocr'), $server->getLogger(), $c->query('CurrentUID'), 
-                            new View('/' . $c->query('CurrentUID') . '/files'), $server->getTempManager(), $c->query('RedisService'), 
-                            $c->query('OcrJobMapper'), $c->query('FileService'), $c->query('AppConfigService'), 
-                            $c->query('PHPUtil'), $c->query('FileUtil'));
+                            new View('/' . $c->query('CurrentUID') . '/files'), $server->getTempManager(), 
+                            $c->query('RedisService'), $c->query('OcrJobMapper'), $c->query('FileService'), 
+                            $c->query('AppConfigService'), $c->query('PHPUtil'), $c->query('FileUtil'));
                 });
         /**
          * Register the Status Service
@@ -198,6 +200,16 @@ function (IAppContainer $c) {
         /**
          * Controller
          */
+        $container->registerService('UserHooks', 
+                function (IAppContainer $c) {
+                    /** @var \OC\Server $server */
+                    $server = $c->query('ServerContainer');
+                    return new UserHooks($c->query('ServerContainer')
+                        ->getUserManager(), $c->query('OcrJobMapper'), $server->getLogger());
+                });
+        /**
+         * Controller
+         */
         $container->registerAlias('PersonalSettingsController', PersonalSettingsController::class);
     }
 
@@ -209,4 +221,14 @@ public function registerPersonal() {
         \OCP\App::registerPersonal($this->getContainer()
             ->getAppName(), 'personal');
     }
-}
+
+    /**
+     * Registers the User Hooks.
+     * @codeCoverageIgnore
+     */
+    public function registerHooks() {
+        $this->getContainer()
+            ->query('UserHooks')
+            ->register();
+    }
+}
diff --git a/lib/Db/OcrJobMapper.php b/lib/Db/OcrJobMapper.php
@@ -3,7 +3,8 @@
 /**
  * Nextcloud - OCR
  * This file is licensed under the Affero General Public License version 3 or
- * later. See the COPYING file.
+ * later.
+ * See the COPYING file.
  * 
  * @author Janis Koehr <janiskoehr@icloud.com>
  * @copyright Janis Koehr 2017
@@ -68,10 +69,11 @@ public function findAll($userId) {
      */
     public function findAllProcessed($userId) {
         $sql = 'SELECT * FROM *PREFIX*ocr_jobs WHERE user_id = ? AND status = ?';
-        return $this->findEntities($sql, [
-                $userId,
-                OcrConstants::STATUS_PROCESSED
-        ]);
+        return $this->findEntities($sql, 
+                [
+                        $userId,
+                        OcrConstants::STATUS_PROCESSED
+                ]);
     }
 
     /**
@@ -83,10 +85,11 @@ public function findAllProcessed($userId) {
      */
     public function findAllPending($userId) {
         $sql = 'SELECT * FROM *PREFIX*ocr_jobs WHERE user_id = ? AND status = ?';
-        return $this->findEntities($sql, [
-                $userId,
-                OcrConstants::STATUS_PENDING
-        ]);
+        return $this->findEntities($sql, 
+                [
+                        $userId,
+                        OcrConstants::STATUS_PENDING
+                ]);
     }
 
     /**
@@ -98,10 +101,25 @@ public function findAllPending($userId) {
      */
     public function findAllFailed($userId) {
         $sql = 'SELECT * FROM *PREFIX*ocr_jobs WHERE user_id = ? AND status = ? AND error_displayed = ?';
+        return $this->findEntities($sql, 
+                [
+                        $userId,
+                        OcrConstants::STATUS_FAILED,
+                        false
+                ]);
+    }
+
+    /**
+     * Deletes all jobs for a given userid.
+     * (For example after user deletion)
+     * 
+     * @param unknown $userId            
+     * @return OcrJob[]
+     */
+    public function deleteAllForUser($userId) {
+        $sql = 'DELETE FROM *PREFIX*ocr_jobs WHERE user_id = ?';
         return $this->findEntities($sql, [
-                $userId,
-                OcrConstants::STATUS_FAILED,
-                false
+                $userId
         ]);
     }
 }
diff --git a/lib/Hooks/UserHooks.php b/lib/Hooks/UserHooks.php
@@ -0,0 +1,62 @@
+<?php
+
+/**
+ * Nextcloud - OCR
+ * This file is licensed under the Affero General Public License version 3 or
+ * later.
+ * See the COPYING file.
+ * 
+ * @author Janis Koehr <janiskoehr@icloud.com>
+ * @copyright Janis Koehr 2017
+ */
+namespace OCA\Ocr\Hooks;
+
+use OCP\IUserManager;
+use OCA\Ocr\Db\OcrJobMapper;
+use OCP\ILogger;
+
+
+/**
+ * Class UserHooks
+ * 
+ * @package OCA\Ocr\Hooks
+ */
+class UserHooks {
+
+    /**
+     *
+     * @var IUserManager
+     */
+    private $userManager;
+
+    /**
+     *
+     * @var OcrJobMapper
+     */
+    private $ocrJobMapper;
+
+    /**
+     *
+     * @var ILogger
+     */
+    private $logger;
+
+    public function __construct(IUserManager $userManager, OcrJobMapper $ocrJobMapper, ILogger $logger) {
+        $this->userManager = $userManager;
+        $this->ocrJobMapper = $ocrJobMapper;
+        $this->logger = $logger;
+    }
+
+    /**
+     * Registers the user hooks.
+     */
+    public function register() {
+        $postDelete = function ($user) {
+            $this->logger->debug('Deleting all jobs for user "{user}" after user deletion (Hook).', [
+                    'user' => $user->getUID()
+            ]);
+            $this->ocrJobMapper->deleteAllForUser($user->getUID());
+        };
+        $this->userManager->listen('\OC\User', 'postDelete', $postDelete);
+    }
+}
diff --git a/tests/Unit/AppInfo/ApplicationTest.php b/tests/Unit/AppInfo/ApplicationTest.php
@@ -104,6 +104,10 @@ public function queryData() {
                 array(
                         'PersonalSettingsController',
                         'OCP\AppFramework\Controller'
+                ),
+                array(
+                        'UserHooks',
+                        'OCA\Ocr\Hooks\UserHooks'
                 )
         );
     }

diff --git a/tests/Unit/Db/OcrJobMapperTest.php b/tests/Unit/Db/OcrJobMapperTest.php
@@ -127,4 +127,12 @@ public function testFindAll() {
         $result = $this->cut->findAll($this->userId);
         $this->assertEquals($this->jobs, $result);
     }
+
+    public function testDeleteAllForUser() {
+        $rows = $this->twoRows;
+        $sql = 'DELETE FROM *PREFIX*ocr_jobs WHERE user_id = ?';
+        $this->setMapperResult($sql, [$this->userId], $rows);
+        $result = $this->cut->deleteAllForUser($this->userId);
+        $this->assertEquals($this->jobs, $result);
+    }
 }