nextcloud / server

lib/private/Files/Utils/Scanner.php

Indentation +198 added lines, -198 removed lines

@@ -49,228 +49,228 @@
  * @package OC\Files\Utils
  */
 class Scanner extends PublicEmitter {
-	const MAX_ENTRIES_TO_COMMIT = 10000;
+    const MAX_ENTRIES_TO_COMMIT = 10000;
 
-	/**
-	 * @var string $user
-	 */
-	private $user;
+    /**
+     * @var string $user
+     */
+    private $user;
 
-	/**
-	 * @var \OCP\IDBConnection
-	 */
-	protected $db;
+    /**
+     * @var \OCP\IDBConnection
+     */
+    protected $db;
 
-	/**
-	 * @var ILogger
-	 */
-	protected $logger;
+    /**
+     * @var ILogger
+     */
+    protected $logger;
 
-	/**
-	 * Whether to use a DB transaction
-	 *
-	 * @var bool
-	 */
-	protected $useTransaction;
+    /**
+     * Whether to use a DB transaction
+     *
+     * @var bool
+     */
+    protected $useTransaction;
 
-	/**
-	 * Number of entries scanned to commit
-	 *
-	 * @var int
-	 */
-	protected $entriesToCommit;
+    /**
+     * Number of entries scanned to commit
+     *
+     * @var int
+     */
+    protected $entriesToCommit;
 
-	/**
-	 * @param string $user
-	 * @param \OCP\IDBConnection $db
-	 * @param ILogger $logger
-	 */
-	public function __construct($user, $db, ILogger $logger) {
-		$this->logger = $logger;
-		$this->user = $user;
-		$this->db = $db;
-		// when DB locking is used, no DB transactions will be used
-		$this->useTransaction = !(\OC::$server->getLockingProvider() instanceof DBLockingProvider);
-	}
+    /**
+     * @param string $user
+     * @param \OCP\IDBConnection $db
+     * @param ILogger $logger
+     */
+    public function __construct($user, $db, ILogger $logger) {
+        $this->logger = $logger;
+        $this->user = $user;
+        $this->db = $db;
+        // when DB locking is used, no DB transactions will be used
+        $this->useTransaction = !(\OC::$server->getLockingProvider() instanceof DBLockingProvider);
+    }
 
-	/**
-	 * get all storages for $dir
-	 *
-	 * @param string $dir
-	 * @return \OC\Files\Mount\MountPoint[]
-	 */
-	protected function getMounts($dir) {
-		//TODO: move to the node based fileapi once that's done
-		\OC_Util::tearDownFS();
-		\OC_Util::setupFS($this->user);
+    /**
+     * get all storages for $dir
+     *
+     * @param string $dir
+     * @return \OC\Files\Mount\MountPoint[]
+     */
+    protected function getMounts($dir) {
+        //TODO: move to the node based fileapi once that's done
+        \OC_Util::tearDownFS();
+        \OC_Util::setupFS($this->user);
 
-		$mountManager = Filesystem::getMountManager();
-		$mounts = $mountManager->findIn($dir);
-		$mounts[] = $mountManager->find($dir);
-		$mounts = array_reverse($mounts); //start with the mount of $dir
+        $mountManager = Filesystem::getMountManager();
+        $mounts = $mountManager->findIn($dir);
+        $mounts[] = $mountManager->find($dir);
+        $mounts = array_reverse($mounts); //start with the mount of $dir
 
-		return $mounts;
-	}
+        return $mounts;
+    }
 
-	/**
-	 * attach listeners to the scanner
-	 *
-	 * @param \OC\Files\Mount\MountPoint $mount
-	 */
-	protected function attachListener($mount) {
-		$scanner = $mount->getStorage()->getScanner();
-		$emitter = $this;
-		$scanner->listen('\OC\Files\Cache\Scanner', 'scanFile', function ($path) use ($mount, $emitter) {
-			$emitter->emit('\OC\Files\Utils\Scanner', 'scanFile', array($mount->getMountPoint() . $path));
-		});
-		$scanner->listen('\OC\Files\Cache\Scanner', 'scanFolder', function ($path) use ($mount, $emitter) {
-			$emitter->emit('\OC\Files\Utils\Scanner', 'scanFolder', array($mount->getMountPoint() . $path));
-		});
-		$scanner->listen('\OC\Files\Cache\Scanner', 'postScanFile', function ($path) use ($mount, $emitter) {
-			$emitter->emit('\OC\Files\Utils\Scanner', 'postScanFile', array($mount->getMountPoint() . $path));
-		});
-		$scanner->listen('\OC\Files\Cache\Scanner', 'postScanFolder', function ($path) use ($mount, $emitter) {
-			$emitter->emit('\OC\Files\Utils\Scanner', 'postScanFolder', array($mount->getMountPoint() . $path));
-		});
-	}
+    /**
+     * attach listeners to the scanner
+     *
+     * @param \OC\Files\Mount\MountPoint $mount
+     */
+    protected function attachListener($mount) {
+        $scanner = $mount->getStorage()->getScanner();
+        $emitter = $this;
+        $scanner->listen('\OC\Files\Cache\Scanner', 'scanFile', function ($path) use ($mount, $emitter) {
+            $emitter->emit('\OC\Files\Utils\Scanner', 'scanFile', array($mount->getMountPoint() . $path));
+        });
+        $scanner->listen('\OC\Files\Cache\Scanner', 'scanFolder', function ($path) use ($mount, $emitter) {
+            $emitter->emit('\OC\Files\Utils\Scanner', 'scanFolder', array($mount->getMountPoint() . $path));
+        });
+        $scanner->listen('\OC\Files\Cache\Scanner', 'postScanFile', function ($path) use ($mount, $emitter) {
+            $emitter->emit('\OC\Files\Utils\Scanner', 'postScanFile', array($mount->getMountPoint() . $path));
+        });
+        $scanner->listen('\OC\Files\Cache\Scanner', 'postScanFolder', function ($path) use ($mount, $emitter) {
+            $emitter->emit('\OC\Files\Utils\Scanner', 'postScanFolder', array($mount->getMountPoint() . $path));
+        });
+    }
 
-	/**
-	 * @param string $dir
-	 */
-	public function backgroundScan($dir) {
-		$mounts = $this->getMounts($dir);
-		foreach ($mounts as $mount) {
-			$storage = $mount->getStorage();
-			if (is_null($storage)) {
-				continue;
-			}
+    /**
+     * @param string $dir
+     */
+    public function backgroundScan($dir) {
+        $mounts = $this->getMounts($dir);
+        foreach ($mounts as $mount) {
+            $storage = $mount->getStorage();
+            if (is_null($storage)) {
+                continue;
+            }
 
-			// don't bother scanning failed storages (shortcut for same result)
-			if ($storage->instanceOfStorage('OC\Files\Storage\FailedStorage')) {
-				continue;
-			}
+            // don't bother scanning failed storages (shortcut for same result)
+            if ($storage->instanceOfStorage('OC\Files\Storage\FailedStorage')) {
+                continue;
+            }
 
-			// don't scan received local shares, these can be scanned when scanning the owner's storage
-			if ($storage->instanceOfStorage(SharedStorage::class)) {
-				continue;
-			}
-			$scanner = $storage->getScanner();
-			$this->attachListener($mount);
+            // don't scan received local shares, these can be scanned when scanning the owner's storage
+            if ($storage->instanceOfStorage(SharedStorage::class)) {
+                continue;
+            }
+            $scanner = $storage->getScanner();
+            $this->attachListener($mount);
 
-			$scanner->listen('\OC\Files\Cache\Scanner', 'removeFromCache', function ($path) use ($storage) {
-				$this->triggerPropagator($storage, $path);
-			});
-			$scanner->listen('\OC\Files\Cache\Scanner', 'updateCache', function ($path) use ($storage) {
-				$this->triggerPropagator($storage, $path);
-			});
-			$scanner->listen('\OC\Files\Cache\Scanner', 'addToCache', function ($path) use ($storage) {
-				$this->triggerPropagator($storage, $path);
-			});
+            $scanner->listen('\OC\Files\Cache\Scanner', 'removeFromCache', function ($path) use ($storage) {
+                $this->triggerPropagator($storage, $path);
+            });
+            $scanner->listen('\OC\Files\Cache\Scanner', 'updateCache', function ($path) use ($storage) {
+                $this->triggerPropagator($storage, $path);
+            });
+            $scanner->listen('\OC\Files\Cache\Scanner', 'addToCache', function ($path) use ($storage) {
+                $this->triggerPropagator($storage, $path);
+            });
 
-			$propagator = $storage->getPropagator();
-			$propagator->beginBatch();
-			$scanner->backgroundScan();
-			$propagator->commitBatch();
-		}
-	}
+            $propagator = $storage->getPropagator();
+            $propagator->beginBatch();
+            $scanner->backgroundScan();
+            $propagator->commitBatch();
+        }
+    }
 
-	/**
-	 * @param string $dir
-	 * @throws \OC\ForbiddenException
-	 * @throws \OCP\Files\NotFoundException
-	 */
-	public function scan($dir = '') {
-		if (!Filesystem::isValidPath($dir)) {
-			throw new \InvalidArgumentException('Invalid path to scan');
-		}
-		$mounts = $this->getMounts($dir);
-		foreach ($mounts as $mount) {
-			$storage = $mount->getStorage();
-			if (is_null($storage)) {
-				continue;
-			}
+    /**
+     * @param string $dir
+     * @throws \OC\ForbiddenException
+     * @throws \OCP\Files\NotFoundException
+     */
+    public function scan($dir = '') {
+        if (!Filesystem::isValidPath($dir)) {
+            throw new \InvalidArgumentException('Invalid path to scan');
+        }
+        $mounts = $this->getMounts($dir);
+        foreach ($mounts as $mount) {
+            $storage = $mount->getStorage();
+            if (is_null($storage)) {
+                continue;
+            }
 
-			// don't bother scanning failed storages (shortcut for same result)
-			if ($storage->instanceOfStorage('OC\Files\Storage\FailedStorage')) {
-				continue;
-			}
+            // don't bother scanning failed storages (shortcut for same result)
+            if ($storage->instanceOfStorage('OC\Files\Storage\FailedStorage')) {
+                continue;
+            }
 
-			// if the home storage isn't writable then the scanner is run as the wrong user
-			if ($storage->instanceOfStorage('\OC\Files\Storage\Home') and
-				(!$storage->isCreatable('') or !$storage->isCreatable('files'))
-			) {
-				if ($storage->file_exists('') or $storage->getCache()->inCache('')) {
-					throw new ForbiddenException();
-				} else {// if the root exists in neither the cache nor the storage the user isn't setup yet
-					break;
-				}
+            // if the home storage isn't writable then the scanner is run as the wrong user
+            if ($storage->instanceOfStorage('\OC\Files\Storage\Home') and
+                (!$storage->isCreatable('') or !$storage->isCreatable('files'))
+            ) {
+                if ($storage->file_exists('') or $storage->getCache()->inCache('')) {
+                    throw new ForbiddenException();
+                } else {// if the root exists in neither the cache nor the storage the user isn't setup yet
+                    break;
+                }
 
-			}
+            }
 
-			// don't scan received local shares, these can be scanned when scanning the owner's storage
-			if ($storage->instanceOfStorage(SharedStorage::class)) {
-				continue;
-			}
-			$relativePath = $mount->getInternalPath($dir);
-			$scanner = $storage->getScanner();
-			$scanner->setUseTransactions(false);
-			$this->attachListener($mount);
+            // don't scan received local shares, these can be scanned when scanning the owner's storage
+            if ($storage->instanceOfStorage(SharedStorage::class)) {
+                continue;
+            }
+            $relativePath = $mount->getInternalPath($dir);
+            $scanner = $storage->getScanner();
+            $scanner->setUseTransactions(false);
+            $this->attachListener($mount);
 
-			$scanner->listen('\OC\Files\Cache\Scanner', 'removeFromCache', function ($path) use ($storage) {
-				$this->postProcessEntry($storage, $path);
-			});
-			$scanner->listen('\OC\Files\Cache\Scanner', 'updateCache', function ($path) use ($storage) {
-				$this->postProcessEntry($storage, $path);
-			});
-			$scanner->listen('\OC\Files\Cache\Scanner', 'addToCache', function ($path) use ($storage) {
-				$this->postProcessEntry($storage, $path);
-			});
+            $scanner->listen('\OC\Files\Cache\Scanner', 'removeFromCache', function ($path) use ($storage) {
+                $this->postProcessEntry($storage, $path);
+            });
+            $scanner->listen('\OC\Files\Cache\Scanner', 'updateCache', function ($path) use ($storage) {
+                $this->postProcessEntry($storage, $path);
+            });
+            $scanner->listen('\OC\Files\Cache\Scanner', 'addToCache', function ($path) use ($storage) {
+                $this->postProcessEntry($storage, $path);
+            });
 
-			if (!$storage->file_exists($relativePath)) {
-				throw new NotFoundException($dir);
-			}
+            if (!$storage->file_exists($relativePath)) {
+                throw new NotFoundException($dir);
+            }
 
-			if ($this->useTransaction) {
-				$this->db->beginTransaction();
-			}
-			try {
-				$propagator = $storage->getPropagator();
-				$propagator->beginBatch();
-				$scanner->scan($relativePath, \OC\Files\Cache\Scanner::SCAN_RECURSIVE, \OC\Files\Cache\Scanner::REUSE_ETAG | \OC\Files\Cache\Scanner::REUSE_SIZE);
-				$cache = $storage->getCache();
-				if ($cache instanceof Cache) {
-					// only re-calculate for the root folder we scanned, anything below that is taken care of by the scanner
-					$cache->correctFolderSize($relativePath);
-				}
-				$propagator->commitBatch();
-			} catch (StorageNotAvailableException $e) {
-				$this->logger->error('Storage ' . $storage->getId() . ' not available');
-				$this->logger->logException($e);
-				$this->emit('\OC\Files\Utils\Scanner', 'StorageNotAvailable', [$e]);
-			}
-			if ($this->useTransaction) {
-				$this->db->commit();
-			}
-		}
-	}
+            if ($this->useTransaction) {
+                $this->db->beginTransaction();
+            }
+            try {
+                $propagator = $storage->getPropagator();
+                $propagator->beginBatch();
+                $scanner->scan($relativePath, \OC\Files\Cache\Scanner::SCAN_RECURSIVE, \OC\Files\Cache\Scanner::REUSE_ETAG | \OC\Files\Cache\Scanner::REUSE_SIZE);
+                $cache = $storage->getCache();
+                if ($cache instanceof Cache) {
+                    // only re-calculate for the root folder we scanned, anything below that is taken care of by the scanner
+                    $cache->correctFolderSize($relativePath);
+                }
+                $propagator->commitBatch();
+            } catch (StorageNotAvailableException $e) {
+                $this->logger->error('Storage ' . $storage->getId() . ' not available');
+                $this->logger->logException($e);
+                $this->emit('\OC\Files\Utils\Scanner', 'StorageNotAvailable', [$e]);
+            }
+            if ($this->useTransaction) {
+                $this->db->commit();
+            }
+        }
+    }
 
-	private function triggerPropagator(IStorage $storage, $internalPath) {
-		$storage->getPropagator()->propagateChange($internalPath, time());
-	}
+    private function triggerPropagator(IStorage $storage, $internalPath) {
+        $storage->getPropagator()->propagateChange($internalPath, time());
+    }
 
-	private function postProcessEntry(IStorage $storage, $internalPath) {
-		$this->triggerPropagator($storage, $internalPath);
-		if ($this->useTransaction) {
-			$this->entriesToCommit++;
-			if ($this->entriesToCommit >= self::MAX_ENTRIES_TO_COMMIT) {
-				$propagator = $storage->getPropagator();
-				$this->entriesToCommit = 0;
-				$this->db->commit();
-				$propagator->commitBatch();
-				$this->db->beginTransaction();
-				$propagator->beginBatch();
-			}
-		}
-	}
+    private function postProcessEntry(IStorage $storage, $internalPath) {
+        $this->triggerPropagator($storage, $internalPath);
+        if ($this->useTransaction) {
+            $this->entriesToCommit++;
+            if ($this->entriesToCommit >= self::MAX_ENTRIES_TO_COMMIT) {
+                $propagator = $storage->getPropagator();
+                $this->entriesToCommit = 0;
+                $this->db->commit();
+                $propagator->commitBatch();
+                $this->db->beginTransaction();
+                $propagator->beginBatch();
+            }
+        }
+    }
 }