Merge pull request #15569 from owncloud/remove-getetag-properties

Remove unneeded getetag entries in properties table

lib/private/repair.php

@@ -34,6 +34,7 @@ use OC\Repair\AssetCache;
 use OC\Repair\CleanTags;
 use OC\Repair\Collation;
 use OC\Repair\DropOldJobs;
+use OC\Repair\RemoveGetETagEntries;
 use OC\Repair\SqliteAutoincrement;
 use OC\Repair\DropOldTables;
 use OC\Repair\FillETags;
@@ -109,6 +110,7 @@ class Repair extends BasicEmitter {
 			new CleanTags(\OC_DB::getConnection()),
 			new DropOldTables(\OC_DB::getConnection()),
 			new DropOldJobs(\OC::$server->getJobList()),
+			new RemoveGetETagEntries(\OC_DB::getConnection()),
 		);
 	}
 

lib/repair/removegetetagentries.php

+<?php
+/**
+ * @author Morris Jobke <hey@morrisjobke.de>
+ *
+ * @copyright Copyright (c) 2015, ownCloud, Inc.
+ * @license AGPL-3.0
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * 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, version 3,
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace OC\Repair;
+
+use OC\Hooks\BasicEmitter;
+use OCP\IDBConnection;
+
+class RemoveGetETagEntries extends BasicEmitter {
+
+	/**
+	 * @var IDBConnection
+	 */
+	protected $connection;
+
+	/**
+	 * @param IDBConnection $connection
+	 */
+	public function __construct(IDBConnection $connection) {
+		$this->connection = $connection;
+	}
+
+	public function getName() {
+		return 'Remove getetag entries in properties table';
+	}
+
+	/**
+	 * Removes all entries with the key "{DAV:}getetag" from the table properties
+	 */
+	public function run() {
+		$sql = 'DELETE FROM `*PREFIX*properties`'
+			. ' WHERE `propertyname` = ?';
+		$deletedRows = $this->connection->executeUpdate($sql, ['{DAV:}getetag']);
+
+		$this->emit(
+			'\OC\Repair',
+			'info',
+			['Removed ' . $deletedRows . ' unneeded "{DAV:}getetag" entries from properties table.']
+		);
+	}
+}

tests/lib/repair/removegetetagentriestest.php

+<?php
+/**
+ * @author Morris Jobke <hey@morrisjobke.de>
+ *
+ * @copyright Copyright (c) 2015, ownCloud, Inc.
+ * @license AGPL-3.0
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * 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, version 3,
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace Test\Repair;
+
+use OC\Repair\RemoveGetETagEntries;
+use Test\TestCase;
+
+class RemoveGetETagEntriesTest extends TestCase {
+	/** @var \OCP\IDBConnection */
+	protected $connection;
+
+	protected function setUp() {
+		parent::setUp();
+
+		$this->connection = \OC::$server->getDatabaseConnection();
+	}
+
+	public function testRun() {
+
+		$userName = 'removePropertiesUser';
+		$data = [
+			[$userName, '/abc.def.txt', '{DAV:}getetag', 'abcdef'],
+			[$userName, '/abc.def.txt', '{DAV:}anotherRandomProperty', 'ghi'],
+		];
+
+		// insert test data
+		$sqlToInsertProperties = 'INSERT INTO `*PREFIX*properties` (`userid`, `propertypath`, `propertyname`, `propertyvalue`) VALUES (?, ?, ? ,?)';
+		foreach ($data as $entry) {
+			$this->connection->executeUpdate($sqlToInsertProperties, $entry);
+		}
+
+		// check if test data is written to DB
+		$sqlToFetchProperties = 'SELECT `userid`, `propertypath`, `propertyname`, `propertyvalue` FROM `*PREFIX*properties` WHERE `userid` = ?';
+		$stmt = $this->connection->executeQuery($sqlToFetchProperties, [$userName]);
+		$entries = $stmt->fetchAll(\PDO::FETCH_NUM);
+
+		$this->assertCount(2, $entries, 'Asserts that two entries are returned as we have inserted two');
+		foreach($entries as $entry) {
+			$this->assertTrue(in_array($entry, $data), 'Asserts that the entries are the ones from the test data set');
+		}
+
+		// run repair step
+		$repair = new RemoveGetETagEntries($this->connection);
+		$repair->run();
+
+		// check if test data is correctly modified in DB
+		$stmt = $this->connection->executeQuery($sqlToFetchProperties, [$userName]);
+		$entries = $stmt->fetchAll(\PDO::FETCH_NUM);
+
+		$this->assertCount(1, $entries, 'Asserts that only one entry is returned after the repair step - the other one has to be removed');
+		$this->assertSame($data[1], $entries[0], 'Asserts that the returned entry is the correct one from the test data set');
+
+		// remove test data
+		$sqlToRemoveProperties = 'DELETE FROM `*PREFIX*properties` WHERE `userid` = ?';
+		$this->connection->executeUpdate($sqlToRemoveProperties, [$userName]);
+	}
+
+}