add scanner interface

This commit is contained in:
Robin Appelman 2015-12-02 15:05:29 +01:00
parent 6d321f5f6b
commit 5fae07f422
4 changed files with 79 additions and 11 deletions

View File

@ -135,9 +135,8 @@ class ObjectTree extends \Sabre\DAV\Tree {
/** /**
* @var \OC\Files\Storage\Storage $storage * @var \OC\Files\Storage\Storage $storage
*/ */
$scanner = $storage->getScanner($internalPath);
// get data directly // get data directly
$data = $scanner->getData($internalPath); $data = $storage->getMetaData($internalPath);
$info = new FileInfo($absPath, $storage, $internalPath, $data, $mount); $info = new FileInfo($absPath, $storage, $internalPath, $data, $mount);
} else { } else {
$info = null; $info = null;

View File

@ -35,7 +35,7 @@ class SharedScanner extends Scanner {
* *
* @return array an array of metadata of the file * @return array an array of metadata of the file
*/ */
public function getData($path){ protected function getData($path){
$data = parent::getData($path); $data = parent::getData($path);
$sourcePath = $this->storage->getSourcePath($path); $sourcePath = $this->storage->getSourcePath($path);
list($sourceStorage, $internalPath) = \OC\Files\Filesystem::resolvePath($sourcePath); list($sourceStorage, $internalPath) = \OC\Files\Filesystem::resolvePath($sourcePath);

View File

@ -37,6 +37,7 @@ namespace OC\Files\Cache;
use OC\Files\Filesystem; use OC\Files\Filesystem;
use OC\Hooks\BasicEmitter; use OC\Hooks\BasicEmitter;
use OCP\Config; use OCP\Config;
use OCP\Files\Cache\IScanner;
use OCP\Lock\ILockingProvider; use OCP\Lock\ILockingProvider;
/** /**
@ -50,7 +51,7 @@ use OCP\Lock\ILockingProvider;
* *
* @package OC\Files\Cache * @package OC\Files\Cache
*/ */
class Scanner extends BasicEmitter { class Scanner extends BasicEmitter implements IScanner {
/** /**
* @var \OC\Files\Storage\Storage $storage * @var \OC\Files\Storage\Storage $storage
*/ */
@ -81,12 +82,6 @@ class Scanner extends BasicEmitter {
*/ */
protected $lockingProvider; protected $lockingProvider;
const SCAN_RECURSIVE = true;
const SCAN_SHALLOW = false;
const REUSE_ETAG = 1;
const REUSE_SIZE = 2;
public function __construct(\OC\Files\Storage\Storage $storage) { public function __construct(\OC\Files\Storage\Storage $storage) {
$this->storage = $storage; $this->storage = $storage;
$this->storageId = $this->storage->getId(); $this->storageId = $this->storage->getId();
@ -112,7 +107,7 @@ class Scanner extends BasicEmitter {
* @param string $path * @param string $path
* @return array an array of metadata of the file * @return array an array of metadata of the file
*/ */
public function getData($path) { protected function getData($path) {
$data = $this->storage->getMetaData($path); $data = $this->storage->getMetaData($path);
if (is_null($data)) { if (is_null($data)) {
\OCP\Util::writeLog('OC\Files\Cache\Scanner', "!!! Path '$path' is not accessible or present !!!", \OCP\Util::DEBUG); \OCP\Util::writeLog('OC\Files\Cache\Scanner', "!!! Path '$path' is not accessible or present !!!", \OCP\Util::DEBUG);

74
lib/public/files/cache/iscanner.php vendored Normal file
View File

@ -0,0 +1,74 @@
<?php
/**
* @author Robin Appelman <icewind@owncloud.com>>
*
* @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 OCP\Files\Cache;
/**
* Scan files form the storage and save to the cache
*/
interface IScanner {
const SCAN_RECURSIVE = true;
const SCAN_SHALLOW = false;
const REUSE_ETAG = 1;
const REUSE_SIZE = 2;
/**
* scan a single file and store it in the cache
*
* @param string $file
* @param int $reuseExisting
* @param int $parentId
* @param array | null $cacheData existing data in the cache for the file to be scanned
* @param bool $lock set to false to disable getting an additional read lock during scanning
* @return array an array of metadata of the scanned file
* @throws \OC\ServerNotAvailableException
* @throws \OCP\Lock\LockedException
*/
public function scanFile($file, $reuseExisting = 0, $parentId = -1, $cacheData = null, $lock = true);
/**
* scan a folder and all it's children
*
* @param string $path
* @param bool $recursive
* @param int $reuse
* @param bool $lock set to false to disable getting an additional read lock during scanning
* @return array an array of the meta data of the scanned file or folder
*/
public function scan($path, $recursive = self::SCAN_RECURSIVE, $reuse = -1, $lock = true);
/**
* check if the file should be ignored when scanning
* NOTE: files with a '.part' extension are ignored as well!
* prevents unfinished put requests to be scanned
*
* @param string $file
* @return boolean
*/
public static function isPartialFile($file);
/**
* walk over any folders that are not fully scanned yet and scan them
*/
public function backgroundScan();
}