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

[stable24] Revert "Remove inefficient fed share scanner" #32848

Merged
merged 1 commit into from
Jun 13, 2022
Merged
Show file tree
Hide file tree
Changes from all 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
70 changes: 70 additions & 0 deletions apps/files_sharing/lib/External/Scanner.php
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,29 @@
use OCP\Files\NotFoundException;
use OCP\Files\StorageInvalidException;
use OCP\Files\StorageNotAvailableException;
use OCP\Http\Client\LocalServerException;
use Psr\Log\LoggerInterface;

class Scanner extends \OC\Files\Cache\Scanner {
/** @var \OCA\Files_Sharing\External\Storage */
protected $storage;

/** {@inheritDoc} */
public function scan($path, $recursive = self::SCAN_RECURSIVE, $reuse = -1, $lock = true) {
try {
if (!$this->storage->remoteIsOwnCloud()) {
return parent::scan($path, $recursive, $reuse, $lock);
}
} catch (LocalServerException $e) {
// Scanner doesn't have dependency injection
\OC::$server->get(LoggerInterface::class)
->warning('Trying to scan files inside invalid external storage: ' . $this->storage->getRemote() . ' for mountpoint ' . $this->storage->getMountPoint() . ' and id ' . $this->storage->getId());
return;
}

$this->scanAll();
}

/**
* Scan a single file and store it in the cache.
* If an exception happened while accessing the external storage,
Expand Down Expand Up @@ -63,4 +81,56 @@ public function scanFile($file, $reuseExisting = 0, $parentId = -1, $cacheData =
$this->storage->checkStorageAvailability();
}
}

/**
* Checks the remote share for changes.
* If changes are available, scan them and update
* the cache.
* @throws NotFoundException
* @throws StorageInvalidException
* @throws \Exception
*/
public function scanAll() {

Check notice

Code scanning / Psalm

MissingReturnType

Method OCA\Files_Sharing\External\Scanner::scanAll does not have a return type, expecting void
try {
$data = $this->storage->getShareInfo();
} catch (\Exception $e) {
$this->storage->checkStorageAvailability();
throw new \Exception(
'Error while scanning remote share: "' .
$this->storage->getRemote() . '" ' .
$e->getMessage()
);
}
if ($data['status'] === 'success') {
$this->addResult($data['data'], '');
} else {
throw new \Exception(
'Error while scanning remote share: "' .
$this->storage->getRemote() . '"'
);
}
}

/**
* @param array $data
* @param string $path
*/
private function addResult($data, $path) {

Check notice

Code scanning / Psalm

MissingReturnType

Method OCA\Files_Sharing\External\Scanner::addResult does not have a return type, expecting void
$id = $this->cache->put($path, $data);
if (isset($data['children'])) {
$children = [];
foreach ($data['children'] as $child) {
$children[$child['name']] = true;
$this->addResult($child, ltrim($path . '/' . $child['name'], '/'));
}

$existingCache = $this->cache->getFolderContentsById($id);
foreach ($existingCache as $existingChild) {
// if an existing child is not in the new data, remove it
if (!isset($children[$existingChild['name']])) {
$this->cache->remove(ltrim($path . '/' . $existingChild['name'], '/'));
}
}
}
}
}
12 changes: 12 additions & 0 deletions apps/files_sharing/tests/External/ScannerTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,18 @@ protected function setUp(): void {
$this->scanner = new Scanner($this->storage);
}

public function testScanAll() {
$this->storage->expects($this->any())
->method('getShareInfo')
->willReturn(['status' => 'success', 'data' => []]);

// FIXME add real tests, we are currently only checking for
// Declaration of OCA\Files_Sharing\External\Scanner::*() should be
// compatible with OC\Files\Cache\Scanner::*()
$this->scanner->scanAll();
$this->addToAssertionCount(1);
}

public function testScan() {
$this->storage->expects($this->any())
->method('getShareInfo')
Expand Down