Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix moving folders out of a cache jail #5424

Merged
merged 4 commits into from
Jul 6, 2017
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions lib/composer/composer/autoload_classmap.php
Original file line number Diff line number Diff line change
Expand Up @@ -739,6 +739,7 @@
'OC\\Repair\\NC11\\MoveAvatarsBackgroundJob' => $baseDir . '/lib/private/Repair/NC11/MoveAvatarsBackgroundJob.php',
'OC\\Repair\\NC12\\InstallCoreBundle' => $baseDir . '/lib/private/Repair/NC12/InstallCoreBundle.php',
'OC\\Repair\\NC12\\UpdateLanguageCodes' => $baseDir . '/lib/private/Repair/NC12/UpdateLanguageCodes.php',
'OC\\Repair\\NC13\\RepairInvalidPaths' => $baseDir . '/lib/private/Repair/NC13/RepairInvalidPaths.php',
'OC\\Repair\\OldGroupMembershipShares' => $baseDir . '/lib/private/Repair/OldGroupMembershipShares.php',
'OC\\Repair\\Owncloud\\SaveAccountsTableData' => $baseDir . '/lib/private/Repair/Owncloud/SaveAccountsTableData.php',
'OC\\Repair\\RemoveRootShares' => $baseDir . '/lib/private/Repair/RemoveRootShares.php',
Expand Down
1 change: 1 addition & 0 deletions lib/composer/composer/autoload_static.php
Original file line number Diff line number Diff line change
Expand Up @@ -769,6 +769,7 @@ class ComposerStaticInit53792487c5a8370acc0b06b1a864ff4c
'OC\\Repair\\NC11\\MoveAvatarsBackgroundJob' => __DIR__ . '/../../..' . '/lib/private/Repair/NC11/MoveAvatarsBackgroundJob.php',
'OC\\Repair\\NC12\\InstallCoreBundle' => __DIR__ . '/../../..' . '/lib/private/Repair/NC12/InstallCoreBundle.php',
'OC\\Repair\\NC12\\UpdateLanguageCodes' => __DIR__ . '/../../..' . '/lib/private/Repair/NC12/UpdateLanguageCodes.php',
'OC\\Repair\\NC13\\RepairInvalidPaths' => __DIR__ . '/../../..' . '/lib/private/Repair/NC13/RepairInvalidPaths.php',
'OC\\Repair\\OldGroupMembershipShares' => __DIR__ . '/../../..' . '/lib/private/Repair/OldGroupMembershipShares.php',
'OC\\Repair\\Owncloud\\SaveAccountsTableData' => __DIR__ . '/../../..' . '/lib/private/Repair/Owncloud/SaveAccountsTableData.php',
'OC\\Repair\\RemoveRootShares' => __DIR__ . '/../../..' . '/lib/private/Repair/RemoveRootShares.php',
Expand Down
12 changes: 11 additions & 1 deletion lib/private/Files/Cache/Wrapper/CacheJail.php
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ protected function filterCacheEntry($entry) {
* get the stored metadata of a file or folder
*
* @param string /int $file
* @return array|false
* @return ICacheEntry|false
*/
public function get($file) {
if (is_string($file) or $file == '') {
Expand Down Expand Up @@ -175,6 +175,16 @@ public function move($source, $target) {
$this->getCache()->move($this->getSourcePath($source), $this->getSourcePath($target));
}

/**
* Get the storage id and path needed for a move
*
* @param string $path
* @return array [$storageId, $internalPath]
*/
protected function getMoveInfo($path) {
return [$this->getNumericStorageId(), $this->getSourcePath($path)];
}

/**
* remove all entries for files that are stored on the storage from the cache
*/
Expand Down
6 changes: 4 additions & 2 deletions lib/private/Repair.php
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
use OC\Repair\OldGroupMembershipShares;
use OC\Repair\Owncloud\SaveAccountsTableData;
use OC\Repair\RemoveRootShares;
use OC\Repair\NC13\RepairInvalidPaths;
use OC\Repair\SqliteAutoincrement;
use OC\Repair\RepairMimeTypes;
use OC\Repair\RepairInvalidShares;
Expand Down Expand Up @@ -143,7 +144,8 @@ public static function getRepairSteps() {
\OC::$server->query(BundleFetcher::class),
\OC::$server->getConfig(),
\OC::$server->query(Installer::class)
)
),
new RepairInvalidPaths(\OC::$server->getDatabaseConnection())
];
}

Expand All @@ -155,7 +157,7 @@ public static function getRepairSteps() {
*/
public static function getExpensiveRepairSteps() {
return [
new OldGroupMembershipShares(\OC::$server->getDatabaseConnection(), \OC::$server->getGroupManager()),
new OldGroupMembershipShares(\OC::$server->getDatabaseConnection(), \OC::$server->getGroupManager())
];
}

Expand Down
125 changes: 125 additions & 0 deletions lib/private/Repair/NC13/RepairInvalidPaths.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
<?php
/**
* @copyright Copyright (c) 2017 Robin Appelman <robin@icewind.nl>
*
* @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 OC\Repair\NC13;


use OCP\IDBConnection;
use OCP\Migration\IOutput;
use OCP\Migration\IRepairStep;

class RepairInvalidPaths implements IRepairStep {
/** @var IDBConnection */
private $connection;

public function __construct(IDBConnection $connection) {
$this->connection = $connection;
}


public function getName() {
return 'Repair invalid paths in file cache';
}

private function getInvalidEntries() {
$builder = $this->connection->getQueryBuilder();

$computedPath = $builder->func()->concat(
'p.path',
$builder->func()->concat($builder->createNamedParameter('/'), 'f.name')
);

//select f.path, f.parent,p.path from oc_filecache f inner join oc_filecache p on f.parent=p.fileid and p.path!='' where f.path != p.path || '/' || f.name;
$query = $builder->select('f.fileid', 'f.path', 'p.path AS parent_path', 'f.name', 'f.parent', 'f.storage')
->from('filecache', 'f')
->innerJoin('f', 'filecache', 'p', $builder->expr()->andX(
$builder->expr()->eq('f.parent', 'p.fileid'),
$builder->expr()->neq('p.name', $builder->createNamedParameter(''))
))
->where($builder->expr()->neq('f.path', $computedPath));

return $query->execute()->fetchAll();
}

private function getId($storage, $path) {
$builder = $this->connection->getQueryBuilder();

$query = $builder->select('fileid')
->from('filecache')
->where($builder->expr()->eq('storage', $builder->createNamedParameter($storage)))
->andWhere($builder->expr()->eq('path', $builder->createNamedParameter($path)));

return $query->execute()->fetchColumn();
}

private function update($fileid, $newPath) {
$builder = $this->connection->getQueryBuilder();

$query = $builder->update('filecache')
->set('path', $builder->createNamedParameter($newPath))
->set('path_hash', $builder->createNamedParameter(md5($newPath)))
->where($builder->expr()->eq('fileid', $builder->createNamedParameter($fileid)));

$query->execute();
}

private function reparent($from, $to) {
$builder = $this->connection->getQueryBuilder();

$query = $builder->update('filecache')
->set('parent', $builder->createNamedParameter($to))
->where($builder->expr()->eq('fileid', $builder->createNamedParameter($from)));
$query->execute();
}

private function delete($fileid) {
$builder = $this->connection->getQueryBuilder();

$query = $builder->delete('filecache')
->where($builder->expr()->eq('fileid', $builder->createNamedParameter($fileid)));
$query->execute();
}

private function repair() {
$entries = $this->getInvalidEntries();
foreach ($entries as $entry) {
$calculatedPath = $entry['parent_path'] . '/' . $entry['name'];
if ($newId = $this->getId($entry['storage'], $calculatedPath)) {
// a new entry with the correct path has already been created, reuse that one and delete the incorrect entry
$this->reparent($entry['fileid'], $newId);
$this->delete($entry['fileid']);
} else {
$this->update($entry['fileid'], $calculatedPath);
}
}
return count($entries);
}

public function run(IOutput $output) {
$versionFromBeforeUpdate = $this->config->getSystemValue('version', '0.0.0');
// was added to 12.0.0.30 and 13.0.0.1
if (version_compare($versionFromBeforeUpdate, '12.0.0.30', '<') || version_compare($versionFromBeforeUpdate, '13.0.0.0', '==')) {
$count = $this->repair();

$output->info('Repaired ' . $count . ' paths');
}
}
}
50 changes: 50 additions & 0 deletions tests/lib/Files/Cache/Wrapper/CacheJailTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@

namespace Test\Files\Cache\Wrapper;

use OC\Files\Cache\Wrapper\CacheJail;
use Test\Files\Cache\CacheTest;

/**
Expand Down Expand Up @@ -80,4 +81,53 @@ function testGetIncomplete() {
//not supported
$this->assertTrue(true);
}

function testMoveFromJail() {
$folderData = array('size' => 100, 'mtime' => 50, 'mimetype' => 'httpd/unix-directory');

$this->sourceCache->put('source', $folderData);
$this->sourceCache->put('source/foo', $folderData);
$this->sourceCache->put('source/foo/bar', $folderData);
$this->sourceCache->put('target', $folderData);

$jail = new CacheJail($this->sourceCache, 'source');

$this->sourceCache->moveFromCache($jail, 'foo', 'target/foo');

$this->assertTrue($this->sourceCache->inCache('target/foo'));
$this->assertTrue($this->sourceCache->inCache('target/foo/bar'));
}

function testMoveToJail() {
$folderData = array('size' => 100, 'mtime' => 50, 'mimetype' => 'httpd/unix-directory');

$this->sourceCache->put('source', $folderData);
$this->sourceCache->put('source/foo', $folderData);
$this->sourceCache->put('source/foo/bar', $folderData);
$this->sourceCache->put('target', $folderData);

$jail = new CacheJail($this->sourceCache, 'target');

$jail->moveFromCache($this->sourceCache, 'source/foo', 'foo');

$this->assertTrue($this->sourceCache->inCache('target/foo'));
$this->assertTrue($this->sourceCache->inCache('target/foo/bar'));
}

function testMoveBetweenJail() {
$folderData = array('size' => 100, 'mtime' => 50, 'mimetype' => 'httpd/unix-directory');

$this->sourceCache->put('source', $folderData);
$this->sourceCache->put('source/foo', $folderData);
$this->sourceCache->put('source/foo/bar', $folderData);
$this->sourceCache->put('target', $folderData);

$jail = new CacheJail($this->sourceCache, 'target');
$sourceJail = new CacheJail($this->sourceCache, 'source');

$jail->moveFromCache($sourceJail, 'foo', 'foo');

$this->assertTrue($this->sourceCache->inCache('target/foo'));
$this->assertTrue($this->sourceCache->inCache('target/foo/bar'));
}
}
111 changes: 111 additions & 0 deletions tests/lib/Repair/RepairInvalidPathsTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
<?php
/**
* @copyright Copyright (c) 2017 Robin Appelman <robin@icewind.nl>
*
* @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 Test\Repair;

use OC\Files\Cache\Cache;
use OC\Files\Storage\Temporary;
use OC\Repair\RepairInvalidPaths;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Test not passing, you moved that file 😉

use OCP\Migration\IOutput;
use Test\TestCase;

/**
* @group DB
*/
class RepairInvalidPathsTest extends TestCase {
/** @var Temporary */
private $storage;
/** @var Cache */
private $cache;
/** @var RepairInvalidPaths */
private $repair;

protected function setUp() {
parent::setUp();

$this->storage = new Temporary();
$this->cache = $this->storage->getCache();
$this->repair = new RepairInvalidPaths(\OC::$server->getDatabaseConnection());
}

protected function tearDown() {
$this->cache->clear();

return parent::tearDown();
}

public function testRepairNonDuplicate() {
$this->storage->mkdir('foo/bar/asd');
$this->storage->mkdir('foo2');
$this->storage->getScanner()->scan('');

$folderId = $this->cache->getId('foo/bar');
$newParentFolderId = $this->cache->getId('foo2');
// failed rename, moved entry is updated but not it's children
$this->cache->update($folderId, ['path' => 'foo2/bar', 'parent' => $newParentFolderId]);

$this->assertTrue($this->cache->inCache('foo2/bar'));
$this->assertTrue($this->cache->inCache('foo/bar/asd'));
$this->assertFalse($this->cache->inCache('foo2/bar/asd'));

$this->assertEquals($folderId, $this->cache->get('foo/bar/asd')['parent']);

$this->repair->run($this->createMock(IOutput::class));

$this->assertTrue($this->cache->inCache('foo2/bar'));
$this->assertTrue($this->cache->inCache('foo2/bar/asd'));
$this->assertFalse($this->cache->inCache('foo/bar/asd'));

$this->assertEquals($folderId, $this->cache->get('foo2/bar/asd')['parent']);
$this->assertEquals($folderId, $this->cache->getId('foo2/bar'));
}

public function testRepairDuplicate() {
$this->storage->mkdir('foo/bar/asd');
$this->storage->mkdir('foo2');
$this->storage->getScanner()->scan('');

$folderId = $this->cache->getId('foo/bar');
$newParentFolderId = $this->cache->getId('foo2');
// failed rename, moved entry is updated but not it's children
$this->cache->update($folderId, ['path' => 'foo2/bar', 'parent' => $newParentFolderId]);
$this->storage->rename('foo/bar', 'foo2/bar');
$this->storage->mkdir('foo2/bar/asd/foo');

// usage causes the renamed subfolder to be scanned
$this->storage->getScanner()->scan('foo2/bar/asd');

$this->assertTrue($this->cache->inCache('foo2/bar'));
$this->assertTrue($this->cache->inCache('foo/bar/asd'));
$this->assertTrue($this->cache->inCache('foo2/bar/asd'));

$this->assertEquals($folderId, $this->cache->get('foo/bar/asd')['parent']);

$this->repair->run($this->createMock(IOutput::class));

$this->assertTrue($this->cache->inCache('foo2/bar'));
$this->assertTrue($this->cache->inCache('foo2/bar/asd'));
$this->assertFalse($this->cache->inCache('foo/bar/asd'));

$this->assertEquals($this->cache->getId('foo2/bar'), $this->cache->get('foo2/bar/asd')['parent']);
$this->assertEquals($this->cache->getId('foo2/bar/asd'), $this->cache->get('foo2/bar/asd/foo')['parent']);
}
}
2 changes: 1 addition & 1 deletion version.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
// between betas, final and RCs. This is _not_ the public version number. Reset minor/patchlevel
// when updating major/minor version number.

$OC_Version = array(13, 0, 0, 0);
$OC_Version = array(13, 0, 0, 1);

// The human readable string
$OC_VersionString = '13.0.0 alpha';
Expand Down