Merge pull request #4675 from nextcloud/fix_4651

Create a photo cache to speedup the contactsmenu

2 files changed, 155 insertions, 131 deletions

diff --git a/apps/dav/tests/unit/CardDAV/CardDavBackendTest.php b/apps/dav/tests/unit/CardDAV/CardDavBackendTest.php
index c108432d65b..f3a271a2db2 100644
--- a/apps/dav/tests/unit/CardDAV/CardDavBackendTest.php
+++ b/apps/dav/tests/unit/CardDAV/CardDavBackendTest.php
@@ -34,9 +34,12 @@ use OCA\DAV\Connector\Sabre\Principal;
 use OCP\DB\QueryBuilder\IQueryBuilder;
 use OCP\IDBConnection;
 use OCP\IL10N;
+use OCP\IUserManager;
 use Sabre\DAV\PropPatch;
 use Sabre\VObject\Component\VCard;
 use Sabre\VObject\Property\Text;
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
+use Symfony\Component\EventDispatcher\GenericEvent;
 use Test\TestCase;
 
 /**
@@ -54,9 +57,12 @@ class CardDavBackendTest extends TestCase {
 	/** @var Principal | \PHPUnit_Framework_MockObject_MockObject */
 	private $principal;
 
-	/** @var \OCP\IUserManager|\PHPUnit_Framework_MockObject_MockObject */
+	/** @var IUserManager|\PHPUnit_Framework_MockObject_MockObject */
 	private $userManager;
 
+	/** @var EventDispatcherInterface|\PHPUnit_Framework_MockObject_MockObject */
+	private $dispatcher;
+
 	/** @var  IDBConnection */
 	private $db;
 
@@ -73,9 +79,7 @@ class CardDavBackendTest extends TestCase {
 	public function setUp() {
 		parent::setUp();
 
-		$this->userManager = $this->getMockBuilder('OCP\IUserManager')
-			->disableOriginalConstructor()
-			->getMock();
+		$this->userManager = $this->createMock(IUserManager::class);
 		$this->principal = $this->getMockBuilder('OCA\DAV\Connector\Sabre\Principal')
 			->disableOriginalConstructor()
 			->setMethods(['getPrincipalByPath', 'getGroupMembership'])
@@ -88,11 +92,11 @@ class CardDavBackendTest extends TestCase {
 		$this->principal->method('getGroupMembership')
 			->withAnyParameters()
 			->willReturn([self::UNIT_TEST_GROUP]);
+		$this->dispatcher = $this->createMock(EventDispatcherInterface::class);
 
 		$this->db = \OC::$server->getDatabaseConnection();
 
-		$this->backend = new CardDavBackend($this->db, $this->principal, $this->userManager, null);
-
+		$this->backend = new CardDavBackend($this->db, $this->principal, $this->userManager, $this->dispatcher);
 		// start every test with a empty cards_properties and cards table
 		$query = $this->db->getQueryBuilder();
 		$query->delete('cards_properties')->execute();
@@ -172,7 +176,7 @@ class CardDavBackendTest extends TestCase {
 
 		/** @var CardDavBackend | \PHPUnit_Framework_MockObject_MockObject $backend */
 		$backend = $this->getMockBuilder(CardDavBackend::class)
-				->setConstructorArgs([$this->db, $this->principal, $this->userManager, null])
+				->setConstructorArgs([$this->db, $this->principal, $this->userManager, $this->dispatcher])
 				->setMethods(['updateProperties', 'purgeProperties'])->getMock();
 
 		// create a new address book
@@ -185,6 +189,16 @@ class CardDavBackendTest extends TestCase {
 		// updateProperties is expected twice, once for createCard and once for updateCard
 		$backend->expects($this->at(0))->method('updateProperties')->with($bookId, $uri, '');
 		$backend->expects($this->at(1))->method('updateProperties')->with($bookId, $uri, '***');
+
+		// Expect event
+		$this->dispatcher->expects($this->at(0))
+			->method('dispatch')
+			->with('\OCA\DAV\CardDAV\CardDavBackend::createCard', $this->callback(function(GenericEvent $e) use ($bookId, $uri) {
+				return $e->getArgument('addressBookId') === $bookId &&
+					$e->getArgument('cardUri') === $uri &&
+					$e->getArgument('cardData') === '';
+			}));
+
 		// create a card
 		$backend->createCard($bookId, $uri, '');
 
@@ -203,11 +217,28 @@ class CardDavBackendTest extends TestCase {
 		$this->assertArrayHasKey('size', $card);
 		$this->assertEquals('', $card['carddata']);
 
+		// Expect event
+		$this->dispatcher->expects($this->at(0))
+			->method('dispatch')
+			->with('\OCA\DAV\CardDAV\CardDavBackend::updateCard', $this->callback(function(GenericEvent $e) use ($bookId, $uri) {
+				return $e->getArgument('addressBookId') === $bookId &&
+					$e->getArgument('cardUri') === $uri &&
+					$e->getArgument('cardData') === '***';
+			}));
+
 		// update the card
 		$backend->updateCard($bookId, $uri, '***');
 		$card = $backend->getCard($bookId, $uri);
 		$this->assertEquals('***', $card['carddata']);
 
+		// Expect event
+		$this->dispatcher->expects($this->at(0))
+			->method('dispatch')
+			->with('\OCA\DAV\CardDAV\CardDavBackend::deleteCard', $this->callback(function(GenericEvent $e) use ($bookId, $uri) {
+				return $e->getArgument('addressBookId') === $bookId &&
+					$e->getArgument('cardUri') === $uri;
+			}));
+
 		// delete the card
 		$backend->expects($this->once())->method('purgeProperties')->with($bookId, $card['id']);
 		$backend->deleteCard($bookId, $uri);
@@ -218,7 +249,7 @@ class CardDavBackendTest extends TestCase {
 	public function testMultiCard() {
 
 		$this->backend = $this->getMockBuilder(CardDavBackend::class)
-			->setConstructorArgs([$this->db, $this->principal, $this->userManager, null])
+			->setConstructorArgs([$this->db, $this->principal, $this->userManager, $this->dispatcher])
 			->setMethods(['updateProperties'])->getMock();
 
 		// create a new address book
@@ -264,7 +295,7 @@ class CardDavBackendTest extends TestCase {
 
 	public function testDeleteWithoutCard() {
 		$this->backend = $this->getMockBuilder(CardDavBackend::class)
-			->setConstructorArgs([$this->db, $this->principal, $this->userManager, null])
+			->setConstructorArgs([$this->db, $this->principal, $this->userManager, $this->dispatcher])
 			->setMethods([
 				'getCardId',
 				'addChange',
@@ -304,7 +335,7 @@ class CardDavBackendTest extends TestCase {
 
 	public function testSyncSupport() {
 		$this->backend = $this->getMockBuilder(CardDavBackend::class)
-			->setConstructorArgs([$this->db, $this->principal, $this->userManager, null])
+			->setConstructorArgs([$this->db, $this->principal, $this->userManager, $this->dispatcher])
 			->setMethods(['updateProperties'])->getMock();
 
 		// create a new address book
@@ -363,7 +394,7 @@ class CardDavBackendTest extends TestCase {
 		$cardId = 2;
 
 		$backend = $this->getMockBuilder(CardDavBackend::class)
-			->setConstructorArgs([$this->db, $this->principal, $this->userManager, null])
+			->setConstructorArgs([$this->db, $this->principal, $this->userManager, $this->dispatcher])
 			->setMethods(['getCardId'])->getMock();
 
 		$backend->expects($this->any())->method('getCardId')->willReturn($cardId);
diff --git a/apps/dav/tests/unit/CardDAV/ImageExportPluginTest.php b/apps/dav/tests/unit/CardDAV/ImageExportPluginTest.php
index ed311e79f4a..e773e41ba5e 100644
--- a/apps/dav/tests/unit/CardDAV/ImageExportPluginTest.php
+++ b/apps/dav/tests/unit/CardDAV/ImageExportPluginTest.php
@@ -25,9 +25,13 @@
 namespace OCA\DAV\Tests\unit\CardDAV;
 
 
+use OCA\DAV\CardDAV\AddressBook;
 use OCA\DAV\CardDAV\ImageExportPlugin;
-use OCP\ILogger;
+use OCA\DAV\CardDAV\PhotoCache;
+use OCP\Files\NotFoundException;
+use OCP\Files\SimpleFS\ISimpleFile;
 use Sabre\CardDAV\Card;
+use Sabre\DAV\Node;
 use Sabre\DAV\Server;
 use Sabre\DAV\Tree;
 use Sabre\HTTP\RequestInterface;
@@ -36,32 +40,32 @@ use Test\TestCase;
 
 class ImageExportPluginTest extends TestCase {
 
-	/** @var ResponseInterface | \PHPUnit_Framework_MockObject_MockObject */
+	/** @var ResponseInterface|\PHPUnit_Framework_MockObject_MockObject */
 	private $response;
-	/** @var RequestInterface | \PHPUnit_Framework_MockObject_MockObject */
+	/** @var RequestInterface|\PHPUnit_Framework_MockObject_MockObject */
 	private $request;
-	/** @var ImageExportPlugin | \PHPUnit_Framework_MockObject_MockObject */
+	/** @var ImageExportPlugin|\PHPUnit_Framework_MockObject_MockObject */
 	private $plugin;
 	/** @var Server */
 	private $server;
-	/** @var Tree | \PHPUnit_Framework_MockObject_MockObject */
+	/** @var Tree|\PHPUnit_Framework_MockObject_MockObject */
 	private $tree;
-	/** @var ILogger | \PHPUnit_Framework_MockObject_MockObject */
-	private $logger;
+	/** @var PhotoCache|\PHPUnit_Framework_MockObject_MockObject */
+	private $cache;
 
 	function setUp() {
 		parent::setUp();
 
-		$this->request = $this->getMockBuilder('Sabre\HTTP\RequestInterface')->getMock();
-		$this->response = $this->getMockBuilder('Sabre\HTTP\ResponseInterface')->getMock();
-		$this->server = $this->getMockBuilder('Sabre\DAV\Server')->getMock();
-		$this->tree = $this->getMockBuilder('Sabre\DAV\Tree')->disableOriginalConstructor()->getMock();
+		$this->request = $this->createMock(RequestInterface::class);
+		$this->response = $this->createMock(ResponseInterface::class);
+		$this->server = $this->createMock(Server::class);
+		$this->tree = $this->createMock(Tree::class);
 		$this->server->tree = $this->tree;
-		$this->logger = $this->getMockBuilder('\OCP\ILogger')->getMock();
+		$this->cache = $this->createMock(PhotoCache::class);
 
-		$this->plugin = $this->getMockBuilder('OCA\DAV\CardDAV\ImageExportPlugin')
+		$this->plugin = $this->getMockBuilder(ImageExportPlugin::class)
 			->setMethods(['getPhoto'])
-			->setConstructorArgs([$this->logger])
+			->setConstructorArgs([$this->cache])
 			->getMock();
 		$this->plugin->initialize($this->server);
 	}
@@ -84,126 +88,115 @@ class ImageExportPluginTest extends TestCase {
 		];
 	}
 
-	public function testNotACard() {
-		$this->request->expects($this->once())->method('getQueryParameters')->willReturn(['photo' => true]);
-		$this->request->expects($this->once())->method('getPath')->willReturn('/files/welcome.txt');
-		$this->tree->expects($this->once())->method('getNodeForPath')->with('/files/welcome.txt')->willReturn(null);
+	public function testNoCard() {
+		$this->request->method('getQueryParameters')
+			->willReturn([
+				'photo'
+			]);
+		$this->request->method('getPath')
+			->willReturn('user/book/card');
+
+		$node = $this->createMock(Node::class);
+		$this->tree->method('getNodeForPath')
+			->with('user/book/card')
+			->willReturn($node);
+
 		$result = $this->plugin->httpGet($this->request, $this->response);
 		$this->assertTrue($result);
 	}
 
+	public function dataTestCard() {
+		return [
+			[null, false],
+			[null, true],
+			[32, false],
+			[32, true],
+		];
+	}
+
 	/**
-	 * @dataProvider providesCardWithOrWithoutPhoto
-	 * @param bool $expected
-	 * @param array $getPhotoResult
+	 * @dataProvider dataTestCard
+	 *
+	 * @param $size
+	 * @param bool $photo
 	 */
-	public function testCardWithOrWithoutPhoto($expected, $getPhotoResult) {
-		$this->request->expects($this->once())->method('getQueryParameters')->willReturn(['photo' => true]);
-		$this->request->expects($this->once())->method('getPath')->willReturn('/files/welcome.txt');
+	public function testCard($size, $photo) {
+		$query = ['photo' => null];
+		if ($size !== null) {
+			$query['size'] = $size;
+		}
+
+		$this->request->method('getQueryParameters')
+			->willReturn($query);
+		$this->request->method('getPath')
+			->willReturn('user/book/card');
 
-		$card = $this->getMockBuilder('Sabre\CardDAV\Card')->disableOriginalConstructor()->getMock();
+		$card = $this->createMock(Card::class);
 		$card->method('getETag')
 			->willReturn('"myEtag"');
-		$this->tree->expects($this->once())->method('getNodeForPath')->with('/files/welcome.txt')->willReturn($card);
-
-		$this->plugin->expects($this->once())->method('getPhoto')->willReturn($getPhotoResult);
-
-		if (!$expected) {
-			$this->response
-				->expects($this->at(0))
-				->method('setHeader')
-				->with('Cache-Control', 'private, max-age=3600, must-revalidate');
-			$this->response
-				->expects($this->at(1))
-				->method('setHeader')
-				->with('Etag', '"myEtag"');
-			$this->response
-				->expects($this->at(2))
+		$card->method('getName')
+			->willReturn('card');
+		$book = $this->createMock(AddressBook::class);
+		$book->method('getResourceId')
+			->willReturn(1);
+
+		$this->tree->method('getNodeForPath')
+			->willReturnCallback(function($path) use ($card, $book) {
+				if ($path === 'user/book/card') {
+					return $card;
+				} else if ($path === 'user/book') {
+					return $book;
+				}
+				$this->fail();
+			});
+
+		$this->response->expects($this->at(0))
+			->method('setHeader')
+			->with('Cache-Control', 'private, max-age=3600, must-revalidate');
+		$this->response->expects($this->at(1))
+			->method('setHeader')
+			->with('Etag', '"myEtag"');
+		$this->response->expects($this->at(2))
+			->method('setHeader')
+			->with('Pragma', 'public');
+
+		$size = $size === null ? -1 : $size;
+
+		if ($photo) {
+			$file = $this->createMock(ISimpleFile::class);
+			$file->method('getMimeType')
+				->willReturn('imgtype');
+			$file->method('getContent')
+				->willReturn('imgdata');
+
+			$this->cache->method('get')
+				->with(1, 'card', $size, $card)
+				->willReturn($file);
+
+			$this->response->expects($this->at(3))
 				->method('setHeader')
-				->with('Pragma', 'public');
-			$this->response
-				->expects($this->at(3))
-				->method('setHeader')
-				->with('Content-Type', $getPhotoResult['Content-Type']);
-			$this->response
-				->expects($this->at(4))
+				->with('Content-Type', 'imgtype');
+			$this->response->expects($this->at(4))
 				->method('setHeader')
 				->with('Content-Disposition', 'attachment');
-			$this->response
-				->expects($this->once())
-				->method('setStatus');
-			$this->response
-				->expects($this->once())
-				->method('setBody');
+
+			$this->response->expects($this->once())
+				->method('setStatus')
+				->with(200);
+			$this->response->expects($this->once())
+				->method('setBody')
+				->with('imgdata');
+
+		} else {
+			$this->cache->method('get')
+				->with(1, 'card', $size, $card)
+				->willThrowException(new NotFoundException());
+			$this->response->expects($this->once())
+				->method('setStatus')
+				->with(404);
 		}
 
 		$result = $this->plugin->httpGet($this->request, $this->response);
-		$this->assertEquals($expected, $result);
-	}
-
-	public function providesCardWithOrWithoutPhoto() {
-		return [
-			[true, null],
-			[false, ['Content-Type' => 'image/jpeg', 'body' => '1234']],
-		];
-	}
-
-	/**
-	 * @dataProvider providesPhotoData
-	 * @param $expected
-	 * @param $cardData
-	 */
-	public function testGetPhoto($expected, $cardData) {
-		/** @var Card | \PHPUnit_Framework_MockObject_MockObject $card */
-		$card = $this->getMockBuilder('Sabre\CardDAV\Card')->disableOriginalConstructor()->getMock();
-		$card->expects($this->once())->method('get')->willReturn($cardData);
-
-		$this->plugin = new ImageExportPlugin($this->logger);
-		$this->plugin->initialize($this->server);
-
-		$result = $this->plugin->getPhoto($card);
-		$this->assertEquals($expected, $result);
-	}
-
-	public function providesPhotoData() {
-		return [
-			'empty vcard' => [
-				false,
-				''
-			],
-			'vcard without PHOTO' => [
-				false,
-				"BEGIN:VCARD\r\nVERSION:3.0\r\nPRODID:-//Sabre//Sabre VObject 4.1.1//EN\r\nUID:12345\r\nFN:12345\r\nN:12345;;;;\r\nEND:VCARD\r\n"
-			],
-			'vcard 3 with PHOTO' => [
-				[
-					'Content-Type' => 'image/jpeg',
-					'body' => '12345'
-				],
-				"BEGIN:VCARD\r\nVERSION:3.0\r\nPRODID:-//Sabre//Sabre VObject 4.1.1//EN\r\nUID:12345\r\nFN:12345\r\nN:12345;;;;\r\nPHOTO;ENCODING=b;TYPE=JPEG:MTIzNDU=\r\nEND:VCARD\r\n"
-			],
-			'vcard 3 with PHOTO URL' => [
-				false,
-				"BEGIN:VCARD\r\nVERSION:3.0\r\nPRODID:-//Sabre//Sabre VObject 4.1.1//EN\r\nUID:12345\r\nFN:12345\r\nN:12345;;;;\r\nPHOTO;TYPE=JPEG;VALUE=URI:http://example.com/photo.jpg\r\nEND:VCARD\r\n"
-			],
-			'vcard 4 with PHOTO' => [
-				[
-					'Content-Type' => 'image/jpeg',
-					'body' => '12345'
-				],
-				"BEGIN:VCARD\r\nVERSION:4.0\r\nPRODID:-//Sabre//Sabre VObject 4.1.1//EN\r\nUID:12345\r\nFN:12345\r\nN:12345;;;;\r\nPHOTO:data:image/jpeg;base64,MTIzNDU=\r\nEND:VCARD\r\n"
-			],
-			'vcard 4 with PHOTO URL' => [
-				false,
-				"BEGIN:VCARD\r\nVERSION:4.0\r\nPRODID:-//Sabre//Sabre VObject 4.1.1//EN\r\nUID:12345\r\nFN:12345\r\nN:12345;;;;\r\nPHOTO;MEDIATYPE=image/jpeg:http://example.org/photo.jpg\r\nEND:VCARD\r\n"
-			],
-			'vcard 4 with PHOTO AND INVALID MIMEtYPE' => [
-				[
-					'Content-Type' => 'application/octet-stream',
-					'body' => '12345'
-				],
-				"BEGIN:VCARD\r\nVERSION:4.0\r\nPRODID:-//Sabre//Sabre VObject 4.1.1//EN\r\nUID:12345\r\nFN:12345\r\nN:12345;;;;\r\nPHOTO:data:image/svg;base64,MTIzNDU=\r\nEND:VCARD\r\n"
-			],
-		];
+		$this->assertFalse($result);
 	}
 }