nextcloud / server

lib/private/legacy/files.php

Doc Comments +1 added lines, -1 removed lines

@@ -338,7 +338,7 @@
 	 *
 	 * @param int $size file size in bytes
 	 * @param array $files override '.htaccess' and '.user.ini' locations
-	 * @return bool|int false on failure, size on success
+	 * @return integer false on failure, size on success
 	 */
 	public static function setUploadLimit($size, $files = []) {
 		//don't allow user to break his config

Indentation +388 added lines, -388 removed lines

@@ -46,396 +46,396 @@
  *
  */
 class OC_Files {
-	const FILE = 1;
-	const ZIP_FILES = 2;
-	const ZIP_DIR = 3;
-
-	const UPLOAD_MIN_LIMIT_BYTES = 1048576; // 1 MiB
-
-
-	private static $multipartBoundary = '';
-
-	/**
-	 * @return string
-	 */
-	private static function getBoundary() {
-		if (empty(self::$multipartBoundary)) {
-			self::$multipartBoundary = md5(mt_rand());
-		}
-		return self::$multipartBoundary;
-	}
-
-	/**
-	 * @param string $filename
-	 * @param string $name
-	 * @param array $rangeArray ('from'=>int,'to'=>int), ...
-	 */
-	private static function sendHeaders($filename, $name, array $rangeArray) {
-		OC_Response::setContentDispositionHeader($name, 'attachment');
-		header('Content-Transfer-Encoding: binary', true);
-		OC_Response::disableCaching();
-		$fileSize = \OC\Files\Filesystem::filesize($filename);
-		$type = \OC::$server->getMimeTypeDetector()->getSecureMimeType(\OC\Files\Filesystem::getMimeType($filename));
-		if ($fileSize > -1) {
-			if (!empty($rangeArray)) {
-			    header('HTTP/1.1 206 Partial Content', true);
-			    header('Accept-Ranges: bytes', true);
-			    if (count($rangeArray) > 1) {
-				$type = 'multipart/byteranges; boundary='.self::getBoundary();
-				// no Content-Length header here
-			    }
-			    else {
-				header(sprintf('Content-Range: bytes %d-%d/%d', $rangeArray[0]['from'], $rangeArray[0]['to'], $fileSize), true);
-				OC_Response::setContentLengthHeader($rangeArray[0]['to'] - $rangeArray[0]['from'] + 1);
-			    }
-			}
-			else {
-			    OC_Response::setContentLengthHeader($fileSize);
-			}
-		}
-		header('Content-Type: '.$type, true);
-	}
-
-	/**
-	 * return the content of a file or return a zip file containing multiple files
-	 *
-	 * @param string $dir
-	 * @param string $files ; separated list of files to download
-	 * @param array $params ; 'head' boolean to only send header of the request ; 'range' http range header
-	 */
-	public static function get($dir, $files, $params = null) {
-
-		$view = \OC\Files\Filesystem::getView();
-		$getType = self::FILE;
-		$filename = $dir;
-		try {
-
-			if (is_array($files) && count($files) === 1) {
-				$files = $files[0];
-			}
-
-			if (!is_array($files)) {
-				$filename = $dir . '/' . $files;
-				if (!$view->is_dir($filename)) {
-					self::getSingleFile($view, $dir, $files, is_null($params) ? array() : $params);
-					return;
-				}
-			}
-
-			$name = 'download';
-			if (is_array($files)) {
-				$getType = self::ZIP_FILES;
-				$basename = basename($dir);
-				if ($basename) {
-					$name = $basename;
-				}
-
-				$filename = $dir . '/' . $name;
-			} else {
-				$filename = $dir . '/' . $files;
-				$getType = self::ZIP_DIR;
-				// downloading root ?
-				if ($files !== '') {
-					$name = $files;
-				}
-			}
-
-			$streamer = new Streamer();
-			OC_Util::obEnd();
-
-			self::lockFiles($view, $dir, $files);
-
-			$streamer->sendHeaders($name);
-			$executionTime = intval(OC::$server->getIniWrapper()->getNumeric('max_execution_time'));
-			if (strpos(@ini_get('disable_functions'), 'set_time_limit') === false) {
-				@set_time_limit(0);
-			}
-			ignore_user_abort(true);
-			if ($getType === self::ZIP_FILES) {
-				foreach ($files as $file) {
-					$file = $dir . '/' . $file;
-					if (\OC\Files\Filesystem::is_file($file)) {
-						$fileSize = \OC\Files\Filesystem::filesize($file);
-						$fileTime = \OC\Files\Filesystem::filemtime($file);
-						$fh = \OC\Files\Filesystem::fopen($file, 'r');
-						$streamer->addFileFromStream($fh, basename($file), $fileSize, $fileTime);
-						fclose($fh);
-					} elseif (\OC\Files\Filesystem::is_dir($file)) {
-						$streamer->addDirRecursive($file);
-					}
-				}
-			} elseif ($getType === self::ZIP_DIR) {
-				$file = $dir . '/' . $files;
-				$streamer->addDirRecursive($file);
-			}
-			$streamer->finalize();
-			set_time_limit($executionTime);
-			self::unlockAllTheFiles($dir, $files, $getType, $view, $filename);
-		} catch (\OCP\Lock\LockedException $ex) {
-			self::unlockAllTheFiles($dir, $files, $getType, $view, $filename);
-			OC::$server->getLogger()->logException($ex);
-			$l = \OC::$server->getL10N('core');
-			$hint = method_exists($ex, 'getHint') ? $ex->getHint() : '';
-			\OC_Template::printErrorPage($l->t('File is currently busy, please try again later'), $hint);
-		} catch (\OCP\Files\ForbiddenException $ex) {
-			self::unlockAllTheFiles($dir, $files, $getType, $view, $filename);
-			OC::$server->getLogger()->logException($ex);
-			$l = \OC::$server->getL10N('core');
-			\OC_Template::printErrorPage($l->t('Can\'t read file'), $ex->getMessage());
-		} catch (\Exception $ex) {
-			self::unlockAllTheFiles($dir, $files, $getType, $view, $filename);
-			OC::$server->getLogger()->logException($ex);
-			$l = \OC::$server->getL10N('core');
-			$hint = method_exists($ex, 'getHint') ? $ex->getHint() : '';
-			\OC_Template::printErrorPage($l->t('Can\'t read file'), $hint);
-		}
-	}
-
-	/**
-	 * @param string $rangeHeaderPos
-	 * @param int $fileSize
-	 * @return array $rangeArray ('from'=>int,'to'=>int), ...
-	 */
-	private static function parseHttpRangeHeader($rangeHeaderPos, $fileSize) {
-		$rArray=explode(',', $rangeHeaderPos);
-		$minOffset = 0;
-		$ind = 0;
-
-		$rangeArray = array();
-
-		foreach ($rArray as $value) {
-			$ranges = explode('-', $value);
-			if (is_numeric($ranges[0])) {
-				if ($ranges[0] < $minOffset) { // case: bytes=500-700,601-999
-					$ranges[0] = $minOffset;
-				}
-				if ($ind > 0 && $rangeArray[$ind-1]['to']+1 == $ranges[0]) { // case: bytes=500-600,601-999
-					$ind--;
-					$ranges[0] = $rangeArray[$ind]['from'];
-				}
-			}
-
-			if (is_numeric($ranges[0]) && is_numeric($ranges[1]) && $ranges[0] < $fileSize && $ranges[0] <= $ranges[1]) {
-				// case: x-x
-				if ($ranges[1] >= $fileSize) {
-					$ranges[1] = $fileSize-1;
-				}
-				$rangeArray[$ind++] = array( 'from' => $ranges[0], 'to' => $ranges[1], 'size' => $fileSize );
-				$minOffset = $ranges[1] + 1;
-				if ($minOffset >= $fileSize) {
-					break;
-				}
-			}
-			elseif (is_numeric($ranges[0]) && $ranges[0] < $fileSize) {
-				// case: x-
-				$rangeArray[$ind++] = array( 'from' => $ranges[0], 'to' => $fileSize-1, 'size' => $fileSize );
-				break;
-			}
-			elseif (is_numeric($ranges[1])) {
-				// case: -x
-				if ($ranges[1] > $fileSize) {
-					$ranges[1] = $fileSize;
-				}
-				$rangeArray[$ind++] = array( 'from' => $fileSize-$ranges[1], 'to' => $fileSize-1, 'size' => $fileSize );
-				break;
-			}
-		}
-		return $rangeArray;
-	}
-
-	/**
-	 * @param View $view
-	 * @param string $name
-	 * @param string $dir
-	 * @param array $params ; 'head' boolean to only send header of the request ; 'range' http range header
-	 */
-	private static function getSingleFile($view, $dir, $name, $params) {
-		$filename = $dir . '/' . $name;
-		OC_Util::obEnd();
-		$view->lockFile($filename, ILockingProvider::LOCK_SHARED);
+    const FILE = 1;
+    const ZIP_FILES = 2;
+    const ZIP_DIR = 3;
+
+    const UPLOAD_MIN_LIMIT_BYTES = 1048576; // 1 MiB
+
+
+    private static $multipartBoundary = '';
+
+    /**
+     * @return string
+     */
+    private static function getBoundary() {
+        if (empty(self::$multipartBoundary)) {
+            self::$multipartBoundary = md5(mt_rand());
+        }
+        return self::$multipartBoundary;
+    }
+
+    /**
+     * @param string $filename
+     * @param string $name
+     * @param array $rangeArray ('from'=>int,'to'=>int), ...
+     */
+    private static function sendHeaders($filename, $name, array $rangeArray) {
+        OC_Response::setContentDispositionHeader($name, 'attachment');
+        header('Content-Transfer-Encoding: binary', true);
+        OC_Response::disableCaching();
+        $fileSize = \OC\Files\Filesystem::filesize($filename);
+        $type = \OC::$server->getMimeTypeDetector()->getSecureMimeType(\OC\Files\Filesystem::getMimeType($filename));
+        if ($fileSize > -1) {
+            if (!empty($rangeArray)) {
+                header('HTTP/1.1 206 Partial Content', true);
+                header('Accept-Ranges: bytes', true);
+                if (count($rangeArray) > 1) {
+                $type = 'multipart/byteranges; boundary='.self::getBoundary();
+                // no Content-Length header here
+                }
+                else {
+                header(sprintf('Content-Range: bytes %d-%d/%d', $rangeArray[0]['from'], $rangeArray[0]['to'], $fileSize), true);
+                OC_Response::setContentLengthHeader($rangeArray[0]['to'] - $rangeArray[0]['from'] + 1);
+                }
+            }
+            else {
+                OC_Response::setContentLengthHeader($fileSize);
+            }
+        }
+        header('Content-Type: '.$type, true);
+    }
+
+    /**
+     * return the content of a file or return a zip file containing multiple files
+     *
+     * @param string $dir
+     * @param string $files ; separated list of files to download
+     * @param array $params ; 'head' boolean to only send header of the request ; 'range' http range header
+     */
+    public static function get($dir, $files, $params = null) {
+
+        $view = \OC\Files\Filesystem::getView();
+        $getType = self::FILE;
+        $filename = $dir;
+        try {
+
+            if (is_array($files) && count($files) === 1) {
+                $files = $files[0];
+            }
+
+            if (!is_array($files)) {
+                $filename = $dir . '/' . $files;
+                if (!$view->is_dir($filename)) {
+                    self::getSingleFile($view, $dir, $files, is_null($params) ? array() : $params);
+                    return;
+                }
+            }
+
+            $name = 'download';
+            if (is_array($files)) {
+                $getType = self::ZIP_FILES;
+                $basename = basename($dir);
+                if ($basename) {
+                    $name = $basename;
+                }
+
+                $filename = $dir . '/' . $name;
+            } else {
+                $filename = $dir . '/' . $files;
+                $getType = self::ZIP_DIR;
+                // downloading root ?
+                if ($files !== '') {
+                    $name = $files;
+                }
+            }
+
+            $streamer = new Streamer();
+            OC_Util::obEnd();
+
+            self::lockFiles($view, $dir, $files);
+
+            $streamer->sendHeaders($name);
+            $executionTime = intval(OC::$server->getIniWrapper()->getNumeric('max_execution_time'));
+            if (strpos(@ini_get('disable_functions'), 'set_time_limit') === false) {
+                @set_time_limit(0);
+            }
+            ignore_user_abort(true);
+            if ($getType === self::ZIP_FILES) {
+                foreach ($files as $file) {
+                    $file = $dir . '/' . $file;
+                    if (\OC\Files\Filesystem::is_file($file)) {
+                        $fileSize = \OC\Files\Filesystem::filesize($file);
+                        $fileTime = \OC\Files\Filesystem::filemtime($file);
+                        $fh = \OC\Files\Filesystem::fopen($file, 'r');
+                        $streamer->addFileFromStream($fh, basename($file), $fileSize, $fileTime);
+                        fclose($fh);
+                    } elseif (\OC\Files\Filesystem::is_dir($file)) {
+                        $streamer->addDirRecursive($file);
+                    }
+                }
+            } elseif ($getType === self::ZIP_DIR) {
+                $file = $dir . '/' . $files;
+                $streamer->addDirRecursive($file);
+            }
+            $streamer->finalize();
+            set_time_limit($executionTime);
+            self::unlockAllTheFiles($dir, $files, $getType, $view, $filename);
+        } catch (\OCP\Lock\LockedException $ex) {
+            self::unlockAllTheFiles($dir, $files, $getType, $view, $filename);
+            OC::$server->getLogger()->logException($ex);
+            $l = \OC::$server->getL10N('core');
+            $hint = method_exists($ex, 'getHint') ? $ex->getHint() : '';
+            \OC_Template::printErrorPage($l->t('File is currently busy, please try again later'), $hint);
+        } catch (\OCP\Files\ForbiddenException $ex) {
+            self::unlockAllTheFiles($dir, $files, $getType, $view, $filename);
+            OC::$server->getLogger()->logException($ex);
+            $l = \OC::$server->getL10N('core');
+            \OC_Template::printErrorPage($l->t('Can\'t read file'), $ex->getMessage());
+        } catch (\Exception $ex) {
+            self::unlockAllTheFiles($dir, $files, $getType, $view, $filename);
+            OC::$server->getLogger()->logException($ex);
+            $l = \OC::$server->getL10N('core');
+            $hint = method_exists($ex, 'getHint') ? $ex->getHint() : '';
+            \OC_Template::printErrorPage($l->t('Can\'t read file'), $hint);
+        }
+    }
+
+    /**
+     * @param string $rangeHeaderPos
+     * @param int $fileSize
+     * @return array $rangeArray ('from'=>int,'to'=>int), ...
+     */
+    private static function parseHttpRangeHeader($rangeHeaderPos, $fileSize) {
+        $rArray=explode(',', $rangeHeaderPos);
+        $minOffset = 0;
+        $ind = 0;
+
+        $rangeArray = array();
+
+        foreach ($rArray as $value) {
+            $ranges = explode('-', $value);
+            if (is_numeric($ranges[0])) {
+                if ($ranges[0] < $minOffset) { // case: bytes=500-700,601-999
+                    $ranges[0] = $minOffset;
+                }
+                if ($ind > 0 && $rangeArray[$ind-1]['to']+1 == $ranges[0]) { // case: bytes=500-600,601-999
+                    $ind--;
+                    $ranges[0] = $rangeArray[$ind]['from'];
+                }
+            }
+
+            if (is_numeric($ranges[0]) && is_numeric($ranges[1]) && $ranges[0] < $fileSize && $ranges[0] <= $ranges[1]) {
+                // case: x-x
+                if ($ranges[1] >= $fileSize) {
+                    $ranges[1] = $fileSize-1;
+                }
+                $rangeArray[$ind++] = array( 'from' => $ranges[0], 'to' => $ranges[1], 'size' => $fileSize );
+                $minOffset = $ranges[1] + 1;
+                if ($minOffset >= $fileSize) {
+                    break;
+                }
+            }
+            elseif (is_numeric($ranges[0]) && $ranges[0] < $fileSize) {
+                // case: x-
+                $rangeArray[$ind++] = array( 'from' => $ranges[0], 'to' => $fileSize-1, 'size' => $fileSize );
+                break;
+            }
+            elseif (is_numeric($ranges[1])) {
+                // case: -x
+                if ($ranges[1] > $fileSize) {
+                    $ranges[1] = $fileSize;
+                }
+                $rangeArray[$ind++] = array( 'from' => $fileSize-$ranges[1], 'to' => $fileSize-1, 'size' => $fileSize );
+                break;
+            }
+        }
+        return $rangeArray;
+    }
+
+    /**
+     * @param View $view
+     * @param string $name
+     * @param string $dir
+     * @param array $params ; 'head' boolean to only send header of the request ; 'range' http range header
+     */
+    private static function getSingleFile($view, $dir, $name, $params) {
+        $filename = $dir . '/' . $name;
+        OC_Util::obEnd();
+        $view->lockFile($filename, ILockingProvider::LOCK_SHARED);
 		
-		$rangeArray = array();
+        $rangeArray = array();
 
-		if (isset($params['range']) && substr($params['range'], 0, 6) === 'bytes=') {
-			$rangeArray = self::parseHttpRangeHeader(substr($params['range'], 6), 
-								 \OC\Files\Filesystem::filesize($filename));
-		}
+        if (isset($params['range']) && substr($params['range'], 0, 6) === 'bytes=') {
+            $rangeArray = self::parseHttpRangeHeader(substr($params['range'], 6), 
+                                    \OC\Files\Filesystem::filesize($filename));
+        }
 		
-		if (\OC\Files\Filesystem::isReadable($filename)) {
-			self::sendHeaders($filename, $name, $rangeArray);
-		} elseif (!\OC\Files\Filesystem::file_exists($filename)) {
-			header("HTTP/1.1 404 Not Found");
-			$tmpl = new OC_Template('', '404', 'guest');
-			$tmpl->printPage();
-			exit();
-		} else {
-			header("HTTP/1.1 403 Forbidden");
-			die('403 Forbidden');
-		}
-		if (isset($params['head']) && $params['head']) {
-			return;
-		}
-		if (!empty($rangeArray)) {
-			try {
-			    if (count($rangeArray) == 1) {
-				$view->readfilePart($filename, $rangeArray[0]['from'], $rangeArray[0]['to']);
-			    }
-			    else {
-				// check if file is seekable (if not throw UnseekableException)
-				// we have to check it before body contents
-				$view->readfilePart($filename, $rangeArray[0]['size'], $rangeArray[0]['size']);
-
-				$type = \OC::$server->getMimeTypeDetector()->getSecureMimeType(\OC\Files\Filesystem::getMimeType($filename));
-
-				foreach ($rangeArray as $range) {
-				    echo "\r\n--".self::getBoundary()."\r\n".
-				         "Content-type: ".$type."\r\n".
-				         "Content-range: bytes ".$range['from']."-".$range['to']."/".$range['size']."\r\n\r\n";
-				    $view->readfilePart($filename, $range['from'], $range['to']);
-				}
-				echo "\r\n--".self::getBoundary()."--\r\n";
-			    }
-			} catch (\OCP\Files\UnseekableException $ex) {
-			    // file is unseekable
-			    header_remove('Accept-Ranges');
-			    header_remove('Content-Range');
-			    header("HTTP/1.1 200 OK");
-			    self::sendHeaders($filename, $name, array());
-			    $view->readfile($filename);
-			}
-		}
-		else {
-		    $view->readfile($filename);
-		}
-	}
-
-	/**
-	 * @param View $view
-	 * @param string $dir
-	 * @param string[]|string $files
-	 */
-	public static function lockFiles($view, $dir, $files) {
-		if (!is_array($files)) {
-			$file = $dir . '/' . $files;
-			$files = [$file];
-		}
-		foreach ($files as $file) {
-			$file = $dir . '/' . $file;
-			$view->lockFile($file, ILockingProvider::LOCK_SHARED);
-			if ($view->is_dir($file)) {
-				$contents = $view->getDirectoryContent($file);
-				$contents = array_map(function($fileInfo) use ($file) {
-					/** @var \OCP\Files\FileInfo $fileInfo */
-					return $file . '/' . $fileInfo->getName();
-				}, $contents);
-				self::lockFiles($view, $dir, $contents);
-			}
-		}
-	}
-
-	/**
-	 * set the maximum upload size limit for apache hosts using .htaccess
-	 *
-	 * @param int $size file size in bytes
-	 * @param array $files override '.htaccess' and '.user.ini' locations
-	 * @return bool|int false on failure, size on success
-	 */
-	public static function setUploadLimit($size, $files = []) {
-		//don't allow user to break his config
-		$size = intval($size);
-		if ($size < self::UPLOAD_MIN_LIMIT_BYTES) {
-			return false;
-		}
-		$size = OC_Helper::phpFileSize($size);
-
-		$phpValueKeys = array(
-			'upload_max_filesize',
-			'post_max_size'
-		);
-
-		// default locations if not overridden by $files
-		$files = array_merge([
-			'.htaccess' => OC::$SERVERROOT . '/.htaccess',
-			'.user.ini' => OC::$SERVERROOT . '/.user.ini'
-		], $files);
-
-		$updateFiles = [
-			$files['.htaccess'] => [
-				'pattern' => '/php_value %1$s (\S)*/',
-				'setting' => 'php_value %1$s %2$s'
-			],
-			$files['.user.ini'] => [
-				'pattern' => '/%1$s=(\S)*/',
-				'setting' => '%1$s=%2$s'
-			]
-		];
-
-		$success = true;
-
-		foreach ($updateFiles as $filename => $patternMap) {
-			// suppress warnings from fopen()
-			$handle = @fopen($filename, 'r+');
-			if (!$handle) {
-				\OCP\Util::writeLog('files',
-					'Can\'t write upload limit to ' . $filename . '. Please check the file permissions',
-					\OCP\Util::WARN);
-				$success = false;
-				continue; // try to update as many files as possible
-			}
-
-			$content = '';
-			while (!feof($handle)) {
-				$content .= fread($handle, 1000);
-			}
-
-			foreach ($phpValueKeys as $key) {
-				$pattern = vsprintf($patternMap['pattern'], [$key]);
-				$setting = vsprintf($patternMap['setting'], [$key, $size]);
-				$hasReplaced = 0;
-				$newContent = preg_replace($pattern, $setting, $content, 2, $hasReplaced);
-				if ($newContent !== null) {
-					$content = $newContent;
-				}
-				if ($hasReplaced === 0) {
-					$content .= "\n" . $setting;
-				}
-			}
-
-			// write file back
-			ftruncate($handle, 0);
-			rewind($handle);
-			fwrite($handle, $content);
-
-			fclose($handle);
-		}
-
-		if ($success) {
-			return OC_Helper::computerFileSize($size);
-		}
-		return false;
-	}
-
-	/**
-	 * @param string $dir
-	 * @param $files
-	 * @param integer $getType
-	 * @param View $view
-	 * @param string $filename
-	 */
-	private static function unlockAllTheFiles($dir, $files, $getType, $view, $filename) {
-		if ($getType === self::FILE) {
-			$view->unlockFile($filename, ILockingProvider::LOCK_SHARED);
-		}
-		if ($getType === self::ZIP_FILES) {
-			foreach ($files as $file) {
-				$file = $dir . '/' . $file;
-				$view->unlockFile($file, ILockingProvider::LOCK_SHARED);
-			}
-		}
-		if ($getType === self::ZIP_DIR) {
-			$file = $dir . '/' . $files;
-			$view->unlockFile($file, ILockingProvider::LOCK_SHARED);
-		}
-	}
+        if (\OC\Files\Filesystem::isReadable($filename)) {
+            self::sendHeaders($filename, $name, $rangeArray);
+        } elseif (!\OC\Files\Filesystem::file_exists($filename)) {
+            header("HTTP/1.1 404 Not Found");
+            $tmpl = new OC_Template('', '404', 'guest');
+            $tmpl->printPage();
+            exit();
+        } else {
+            header("HTTP/1.1 403 Forbidden");
+            die('403 Forbidden');
+        }
+        if (isset($params['head']) && $params['head']) {
+            return;
+        }
+        if (!empty($rangeArray)) {
+            try {
+                if (count($rangeArray) == 1) {
+                $view->readfilePart($filename, $rangeArray[0]['from'], $rangeArray[0]['to']);
+                }
+                else {
+                // check if file is seekable (if not throw UnseekableException)
+                // we have to check it before body contents
+                $view->readfilePart($filename, $rangeArray[0]['size'], $rangeArray[0]['size']);
+
+                $type = \OC::$server->getMimeTypeDetector()->getSecureMimeType(\OC\Files\Filesystem::getMimeType($filename));
+
+                foreach ($rangeArray as $range) {
+                    echo "\r\n--".self::getBoundary()."\r\n".
+                            "Content-type: ".$type."\r\n".
+                            "Content-range: bytes ".$range['from']."-".$range['to']."/".$range['size']."\r\n\r\n";
+                    $view->readfilePart($filename, $range['from'], $range['to']);
+                }
+                echo "\r\n--".self::getBoundary()."--\r\n";
+                }
+            } catch (\OCP\Files\UnseekableException $ex) {
+                // file is unseekable
+                header_remove('Accept-Ranges');
+                header_remove('Content-Range');
+                header("HTTP/1.1 200 OK");
+                self::sendHeaders($filename, $name, array());
+                $view->readfile($filename);
+            }
+        }
+        else {
+            $view->readfile($filename);
+        }
+    }
+
+    /**
+     * @param View $view
+     * @param string $dir
+     * @param string[]|string $files
+     */
+    public static function lockFiles($view, $dir, $files) {
+        if (!is_array($files)) {
+            $file = $dir . '/' . $files;
+            $files = [$file];
+        }
+        foreach ($files as $file) {
+            $file = $dir . '/' . $file;
+            $view->lockFile($file, ILockingProvider::LOCK_SHARED);
+            if ($view->is_dir($file)) {
+                $contents = $view->getDirectoryContent($file);
+                $contents = array_map(function($fileInfo) use ($file) {
+                    /** @var \OCP\Files\FileInfo $fileInfo */
+                    return $file . '/' . $fileInfo->getName();
+                }, $contents);
+                self::lockFiles($view, $dir, $contents);
+            }
+        }
+    }
+
+    /**
+     * set the maximum upload size limit for apache hosts using .htaccess
+     *
+     * @param int $size file size in bytes
+     * @param array $files override '.htaccess' and '.user.ini' locations
+     * @return bool|int false on failure, size on success
+     */
+    public static function setUploadLimit($size, $files = []) {
+        //don't allow user to break his config
+        $size = intval($size);
+        if ($size < self::UPLOAD_MIN_LIMIT_BYTES) {
+            return false;
+        }
+        $size = OC_Helper::phpFileSize($size);
+
+        $phpValueKeys = array(
+            'upload_max_filesize',
+            'post_max_size'
+        );
+
+        // default locations if not overridden by $files
+        $files = array_merge([
+            '.htaccess' => OC::$SERVERROOT . '/.htaccess',
+            '.user.ini' => OC::$SERVERROOT . '/.user.ini'
+        ], $files);
+
+        $updateFiles = [
+            $files['.htaccess'] => [
+                'pattern' => '/php_value %1$s (\S)*/',
+                'setting' => 'php_value %1$s %2$s'
+            ],
+            $files['.user.ini'] => [
+                'pattern' => '/%1$s=(\S)*/',
+                'setting' => '%1$s=%2$s'
+            ]
+        ];
+
+        $success = true;
+
+        foreach ($updateFiles as $filename => $patternMap) {
+            // suppress warnings from fopen()
+            $handle = @fopen($filename, 'r+');
+            if (!$handle) {
+                \OCP\Util::writeLog('files',
+                    'Can\'t write upload limit to ' . $filename . '. Please check the file permissions',
+                    \OCP\Util::WARN);
+                $success = false;
+                continue; // try to update as many files as possible
+            }
+
+            $content = '';
+            while (!feof($handle)) {
+                $content .= fread($handle, 1000);
+            }
+
+            foreach ($phpValueKeys as $key) {
+                $pattern = vsprintf($patternMap['pattern'], [$key]);
+                $setting = vsprintf($patternMap['setting'], [$key, $size]);
+                $hasReplaced = 0;
+                $newContent = preg_replace($pattern, $setting, $content, 2, $hasReplaced);
+                if ($newContent !== null) {
+                    $content = $newContent;
+                }
+                if ($hasReplaced === 0) {
+                    $content .= "\n" . $setting;
+                }
+            }
+
+            // write file back
+            ftruncate($handle, 0);
+            rewind($handle);
+            fwrite($handle, $content);
+
+            fclose($handle);
+        }
+
+        if ($success) {
+            return OC_Helper::computerFileSize($size);
+        }
+        return false;
+    }
+
+    /**
+     * @param string $dir
+     * @param $files
+     * @param integer $getType
+     * @param View $view
+     * @param string $filename
+     */
+    private static function unlockAllTheFiles($dir, $files, $getType, $view, $filename) {
+        if ($getType === self::FILE) {
+            $view->unlockFile($filename, ILockingProvider::LOCK_SHARED);
+        }
+        if ($getType === self::ZIP_FILES) {
+            foreach ($files as $file) {
+                $file = $dir . '/' . $file;
+                $view->unlockFile($file, ILockingProvider::LOCK_SHARED);
+            }
+        }
+        if ($getType === self::ZIP_DIR) {
+            $file = $dir . '/' . $files;
+            $view->unlockFile($file, ILockingProvider::LOCK_SHARED);
+        }
+    }
 
 }

apps/dav/lib/DAV/SystemPrincipalBackend.php

Indentation +161 added lines, -161 removed lines

@@ -27,165 +27,165 @@
 
 class SystemPrincipalBackend extends AbstractBackend {
 
-	/**
-	 * Returns a list of principals based on a prefix.
-	 *
-	 * This prefix will often contain something like 'principals'. You are only
-	 * expected to return principals that are in this base path.
-	 *
-	 * You are expected to return at least a 'uri' for every user, you can
-	 * return any additional properties if you wish so. Common properties are:
-	 *   {DAV:}displayname
-	 *   {http://sabredav.org/ns}email-address - This is a custom SabreDAV
-	 *     field that's actually injected in a number of other properties. If
-	 *     you have an email address, use this property.
-	 *
-	 * @param string $prefixPath
-	 * @return array
-	 */
-	function getPrincipalsByPrefix($prefixPath) {
-		$principals = [];
-
-		if ($prefixPath === 'principals/system') {
-			$principals[] = [
-				'uri' => 'principals/system/system',
-				'{DAV:}displayname' => 'system',
-			];
-			$principals[] = [
-				'uri' => 'principals/system/public',
-				'{DAV:}displayname' => 'public',
-			];
-		}
-
-		return $principals;
-	}
-
-	/**
-	 * Returns a specific principal, specified by it's path.
-	 * The returned structure should be the exact same as from
-	 * getPrincipalsByPrefix.
-	 *
-	 * @param string $path
-	 * @return array
-	 */
-	function getPrincipalByPath($path) {
-
-		if ($path === 'principals/system/system') {
-			$principal = [
-				'uri' => 'principals/system/system',
-				'{DAV:}displayname' => 'system',
-			];
-			return $principal;
-		}
-		if ($path === 'principals/system/public') {
-			$principal = [
-				'uri' => 'principals/system/public',
-				'{DAV:}displayname' => 'public',
-			];
-			return $principal;
-		}
-
-		return null;
-	}
-
-	/**
-	 * Updates one ore more webdav properties on a principal.
-	 *
-	 * The list of mutations is stored in a Sabre\DAV\PropPatch object.
-	 * To do the actual updates, you must tell this object which properties
-	 * you're going to process with the handle() method.
-	 *
-	 * Calling the handle method is like telling the PropPatch object "I
-	 * promise I can handle updating this property".
-	 *
-	 * Read the PropPatch documentation for more info and examples.
-	 *
-	 * @param string $path
-	 * @param \Sabre\DAV\PropPatch $propPatch
-	 * @return void
-	 */
-	function updatePrincipal($path, \Sabre\DAV\PropPatch $propPatch) {
-	}
-
-	/**
-	 * This method is used to search for principals matching a set of
-	 * properties.
-	 *
-	 * This search is specifically used by RFC3744's principal-property-search
-	 * REPORT.
-	 *
-	 * The actual search should be a unicode-non-case-sensitive search. The
-	 * keys in searchProperties are the WebDAV property names, while the values
-	 * are the property values to search on.
-	 *
-	 * By default, if multiple properties are submitted to this method, the
-	 * various properties should be combined with 'AND'. If $test is set to
-	 * 'anyof', it should be combined using 'OR'.
-	 *
-	 * This method should simply return an array with full principal uri's.
-	 *
-	 * If somebody attempted to search on a property the backend does not
-	 * support, you should simply return 0 results.
-	 *
-	 * You can also just return 0 results if you choose to not support
-	 * searching at all, but keep in mind that this may stop certain features
-	 * from working.
-	 *
-	 * @param string $prefixPath
-	 * @param array $searchProperties
-	 * @param string $test
-	 * @return array
-	 */
-	function searchPrincipals($prefixPath, array $searchProperties, $test = 'allof') {
-		return [];
-	}
-
-	/**
-	 * Returns the list of members for a group-principal
-	 *
-	 * @param string $principal
-	 * @return array
-	 */
-	function getGroupMemberSet($principal) {
-		// TODO: for now the group principal has only one member, the user itself
-		$principal = $this->getPrincipalByPath($principal);
-		if (!$principal) {
-			throw new \Sabre\DAV\Exception('Principal not found');
-		}
-
-		return [$principal['uri']];
-	}
-
-	/**
-	 * Returns the list of groups a principal is a member of
-	 *
-	 * @param string $principal
-	 * @return array
-	 */
-	function getGroupMembership($principal) {
-		list($prefix, ) = \Sabre\Uri\split($principal);
-
-		if ($prefix === 'principals/system') {
-			$principal = $this->getPrincipalByPath($principal);
-			if (!$principal) {
-				throw new \Sabre\DAV\Exception('Principal not found');
-			}
-
-			return [];
-		}
-		return [];
-	}
-
-	/**
-	 * Updates the list of group members for a group principal.
-	 *
-	 * The principals should be passed as a list of uri's.
-	 *
-	 * @param string $principal
-	 * @param array $members
-	 * @return void
-	 */
-	function setGroupMemberSet($principal, array $members) {
-		throw new \Sabre\DAV\Exception('Setting members of the group is not supported yet');
-	}
+    /**
+     * Returns a list of principals based on a prefix.
+     *
+     * This prefix will often contain something like 'principals'. You are only
+     * expected to return principals that are in this base path.
+     *
+     * You are expected to return at least a 'uri' for every user, you can
+     * return any additional properties if you wish so. Common properties are:
+     *   {DAV:}displayname
+     *   {http://sabredav.org/ns}email-address - This is a custom SabreDAV
+     *     field that's actually injected in a number of other properties. If
+     *     you have an email address, use this property.
+     *
+     * @param string $prefixPath
+     * @return array
+     */
+    function getPrincipalsByPrefix($prefixPath) {
+        $principals = [];
+
+        if ($prefixPath === 'principals/system') {
+            $principals[] = [
+                'uri' => 'principals/system/system',
+                '{DAV:}displayname' => 'system',
+            ];
+            $principals[] = [
+                'uri' => 'principals/system/public',
+                '{DAV:}displayname' => 'public',
+            ];
+        }
+
+        return $principals;
+    }
+
+    /**
+     * Returns a specific principal, specified by it's path.
+     * The returned structure should be the exact same as from
+     * getPrincipalsByPrefix.
+     *
+     * @param string $path
+     * @return array
+     */
+    function getPrincipalByPath($path) {
+
+        if ($path === 'principals/system/system') {
+            $principal = [
+                'uri' => 'principals/system/system',
+                '{DAV:}displayname' => 'system',
+            ];
+            return $principal;
+        }
+        if ($path === 'principals/system/public') {
+            $principal = [
+                'uri' => 'principals/system/public',
+                '{DAV:}displayname' => 'public',
+            ];
+            return $principal;
+        }
+
+        return null;
+    }
+
+    /**
+     * Updates one ore more webdav properties on a principal.
+     *
+     * The list of mutations is stored in a Sabre\DAV\PropPatch object.
+     * To do the actual updates, you must tell this object which properties
+     * you're going to process with the handle() method.
+     *
+     * Calling the handle method is like telling the PropPatch object "I
+     * promise I can handle updating this property".
+     *
+     * Read the PropPatch documentation for more info and examples.
+     *
+     * @param string $path
+     * @param \Sabre\DAV\PropPatch $propPatch
+     * @return void
+     */
+    function updatePrincipal($path, \Sabre\DAV\PropPatch $propPatch) {
+    }
+
+    /**
+     * This method is used to search for principals matching a set of
+     * properties.
+     *
+     * This search is specifically used by RFC3744's principal-property-search
+     * REPORT.
+     *
+     * The actual search should be a unicode-non-case-sensitive search. The
+     * keys in searchProperties are the WebDAV property names, while the values
+     * are the property values to search on.
+     *
+     * By default, if multiple properties are submitted to this method, the
+     * various properties should be combined with 'AND'. If $test is set to
+     * 'anyof', it should be combined using 'OR'.
+     *
+     * This method should simply return an array with full principal uri's.
+     *
+     * If somebody attempted to search on a property the backend does not
+     * support, you should simply return 0 results.
+     *
+     * You can also just return 0 results if you choose to not support
+     * searching at all, but keep in mind that this may stop certain features
+     * from working.
+     *
+     * @param string $prefixPath
+     * @param array $searchProperties
+     * @param string $test
+     * @return array
+     */
+    function searchPrincipals($prefixPath, array $searchProperties, $test = 'allof') {
+        return [];
+    }
+
+    /**
+     * Returns the list of members for a group-principal
+     *
+     * @param string $principal
+     * @return array
+     */
+    function getGroupMemberSet($principal) {
+        // TODO: for now the group principal has only one member, the user itself
+        $principal = $this->getPrincipalByPath($principal);
+        if (!$principal) {
+            throw new \Sabre\DAV\Exception('Principal not found');
+        }
+
+        return [$principal['uri']];
+    }
+
+    /**
+     * Returns the list of groups a principal is a member of
+     *
+     * @param string $principal
+     * @return array
+     */
+    function getGroupMembership($principal) {
+        list($prefix, ) = \Sabre\Uri\split($principal);
+
+        if ($prefix === 'principals/system') {
+            $principal = $this->getPrincipalByPath($principal);
+            if (!$principal) {
+                throw new \Sabre\DAV\Exception('Principal not found');
+            }
+
+            return [];
+        }
+        return [];
+    }
+
+    /**
+     * Updates the list of group members for a group principal.
+     *
+     * The principals should be passed as a list of uri's.
+     *
+     * @param string $principal
+     * @param array $members
+     * @return void
+     */
+    function setGroupMemberSet($principal, array $members) {
+        throw new \Sabre\DAV\Exception('Setting members of the group is not supported yet');
+    }
 }

Spacing +1 added lines, -1 removed lines

@@ -163,7 +163,7 @@
 	 * @return array
 	 */
 	function getGroupMembership($principal) {
-		list($prefix, ) = \Sabre\Uri\split($principal);
+		list($prefix,) = \Sabre\Uri\split($principal);
 
 		if ($prefix === 'principals/system') {
 			$principal = $this->getPrincipalByPath($principal);

apps/files/lib/Command/ScanAppData.php

Indentation +262 added lines, -262 removed lines

@@ -19,266 +19,266 @@
 
 class ScanAppData extends Base {
 
-	/** @var IRootFolder */
-	protected $root;
-	/** @var IConfig */
-	protected $config;
-	/** @var float */
-	protected $execTime = 0;
-	/** @var int */
-	protected $foldersCounter = 0;
-	/** @var int */
-	protected $filesCounter = 0;
-
-	public function __construct(IRootFolder $rootFolder, IConfig $config) {
-		parent::__construct();
-
-		$this->root = $rootFolder;
-		$this->config = $config;
-	}
-
-	protected function configure() {
-		parent::configure();
-
-		$this
-			->setName('files:scan-app-data')
-			->setDescription('rescan the AppData folder')
-			->addOption(
-				'quiet',
-				'q',
-				InputOption::VALUE_NONE,
-				'suppress any output'
-			)
-			->addOption(
-				'verbose',
-				'-v|vv|vvv',
-				InputOption::VALUE_NONE,
-				'verbose the output'
-			);
-	}
-
-	public function checkScanWarning($fullPath, OutputInterface $output) {
-		$normalizedPath = basename(\OC\Files\Filesystem::normalizePath($fullPath));
-		$path = basename($fullPath);
-
-		if ($normalizedPath !== $path) {
-			$output->writeln("\t<error>Entry \"" . $fullPath . '" will not be accessible due to incompatible encoding</error>');
-		}
-	}
-
-	protected function scanFiles($verbose, OutputInterface $output) {
-		try {
-			$appData = $this->getAppDataFolder();
-		} catch (NotFoundException $e) {
-			$output->writeln('NoAppData folder found');
-			return;
-		}
-
-		$connection = $this->reconnectToDatabase($output);
-		$scanner = new \OC\Files\Utils\Scanner(null, $connection, \OC::$server->getLogger());
-		# check on each file/folder if there was a user interrupt (ctrl-c) and throw an exception
-		# printout and count
-		if ($verbose) {
-			$scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function ($path) use ($output) {
-				$output->writeln("\tFile   <info>$path</info>");
-				$this->filesCounter += 1;
-				if ($this->hasBeenInterrupted()) {
-					throw new InterruptedException();
-				}
-			});
-			$scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function ($path) use ($output) {
-				$output->writeln("\tFolder <info>$path</info>");
-				$this->foldersCounter += 1;
-				if ($this->hasBeenInterrupted()) {
-					throw new InterruptedException();
-				}
-			});
-			$scanner->listen('\OC\Files\Utils\Scanner', 'StorageNotAvailable', function (StorageNotAvailableException $e) use ($output) {
-				$output->writeln("Error while scanning, storage not available (" . $e->getMessage() . ")");
-			});
-			# count only
-		} else {
-			$scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function () use ($output) {
-				$this->filesCounter += 1;
-				if ($this->hasBeenInterrupted()) {
-					throw new InterruptedException();
-				}
-			});
-			$scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function () use ($output) {
-				$this->foldersCounter += 1;
-				if ($this->hasBeenInterrupted()) {
-					throw new InterruptedException();
-				}
-			});
-		}
-		$scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function($path) use ($output) {
-			$this->checkScanWarning($path, $output);
-		});
-		$scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function($path) use ($output) {
-			$this->checkScanWarning($path, $output);
-		});
-
-		try {
-			$scanner->scan($appData->getPath());
-		} catch (ForbiddenException $e) {
-			$output->writeln("<error>Storage not writable</error>");
-			$output->writeln("Make sure you're running the scan command only as the user the web server runs as");
-		} catch (InterruptedException $e) {
-			# exit the function if ctrl-c has been pressed
-			$output->writeln('Interrupted by user');
-		} catch (NotFoundException $e) {
-			$output->writeln('<error>Path not found: ' . $e->getMessage() . '</error>');
-		} catch (\Exception $e) {
-			$output->writeln('<error>Exception during scan: ' . $e->getMessage() . '</error>');
-			$output->writeln('<error>' . $e->getTraceAsString() . '</error>');
-		}
-	}
-
-
-	protected function execute(InputInterface $input, OutputInterface $output) {
-		# no messaging level option means: no full printout but statistics
-		# $quiet   means no print at all
-		# $verbose means full printout including statistics
-		# -q	-v	full	stat
-		#  0	 0	no	yes
-		#  0	 1	yes	yes
-		#  1	--	no	no  (quiet overrules verbose)
-		$verbose = $input->getOption('verbose');
-		$quiet = $input->getOption('quiet');
-		# restrict the verbosity level to VERBOSITY_VERBOSE
-		if ($output->getVerbosity() > OutputInterface::VERBOSITY_VERBOSE) {
-			$output->setVerbosity(OutputInterface::VERBOSITY_VERBOSE);
-		}
-		if ($quiet) {
-			$verbose = false;
-		}
-
-		$output->writeln("\nScanning AppData for files");
-
-		$this->initTools();
-
-		$this->scanFiles($verbose, $output);
-
-		# stat: printout statistics if $quiet was not set
-		if (!$quiet) {
-			$this->presentStats($output);
-		}
-	}
-
-	/**
-	 * Initialises some useful tools for the Command
-	 */
-	protected function initTools() {
-		// Start the timer
-		$this->execTime = -microtime(true);
-		// Convert PHP errors to exceptions
-		set_error_handler([$this, 'exceptionErrorHandler'], E_ALL);
-	}
-
-	/**
-	 * Processes PHP errors as exceptions in order to be able to keep track of problems
-	 *
-	 * @see https://secure.php.net/manual/en/function.set-error-handler.php
-	 *
-	 * @param int $severity the level of the error raised
-	 * @param string $message
-	 * @param string $file the filename that the error was raised in
-	 * @param int $line the line number the error was raised
-	 *
-	 * @throws \ErrorException
-	 */
-	public function exceptionErrorHandler($severity, $message, $file, $line) {
-		if (!(error_reporting() & $severity)) {
-			// This error code is not included in error_reporting
-			return;
-		}
-		throw new \ErrorException($message, 0, $severity, $file, $line);
-	}
-
-	/**
-	 * @param OutputInterface $output
-	 */
-	protected function presentStats(OutputInterface $output) {
-		// Stop the timer
-		$this->execTime += microtime(true);
-		$output->writeln("");
-
-		$headers = [
-			'Folders', 'Files', 'Elapsed time'
-		];
-
-		$this->showSummary($headers, null, $output);
-	}
-
-	/**
-	 * Shows a summary of operations
-	 *
-	 * @param string[] $headers
-	 * @param string[] $rows
-	 * @param OutputInterface $output
-	 */
-	protected function showSummary($headers, $rows, OutputInterface $output) {
-		$niceDate = $this->formatExecTime();
-		if (!$rows) {
-			$rows = [
-				$this->foldersCounter,
-				$this->filesCounter,
-				$niceDate,
-			];
-		}
-		$table = new Table($output);
-		$table
-			->setHeaders($headers)
-			->setRows([$rows]);
-		$table->render();
-	}
-
-
-	/**
-	 * Formats microtime into a human readable format
-	 *
-	 * @return string
-	 */
-	protected function formatExecTime() {
-		list($secs, ) = explode('.', sprintf("%.1f", ($this->execTime)));
-
-		# if you want to have microseconds add this:   . '.' . $tens;
-		return date('H:i:s', $secs);
-	}
-
-	/**
-	 * @return \OCP\IDBConnection
-	 */
-	protected function reconnectToDatabase(OutputInterface $output) {
-		/** @var Connection | IDBConnection $connection*/
-		$connection = \OC::$server->getDatabaseConnection();
-		try {
-			$connection->close();
-		} catch (\Exception $ex) {
-			$output->writeln("<info>Error while disconnecting from database: {$ex->getMessage()}</info>");
-		}
-		while (!$connection->isConnected()) {
-			try {
-				$connection->connect();
-			} catch (\Exception $ex) {
-				$output->writeln("<info>Error while re-connecting to database: {$ex->getMessage()}</info>");
-				sleep(60);
-			}
-		}
-		return $connection;
-	}
-
-	/**
-	 * @return \OCP\Files\Folder
-	 * @throws NotFoundException
-	 */
-	private function getAppDataFolder() {
-		$instanceId = $this->config->getSystemValue('instanceid', null);
-
-		if ($instanceId === null) {
-			throw new NotFoundException();
-		}
-
-		return $this->root->get('appdata_'.$instanceId);
-	}
+    /** @var IRootFolder */
+    protected $root;
+    /** @var IConfig */
+    protected $config;
+    /** @var float */
+    protected $execTime = 0;
+    /** @var int */
+    protected $foldersCounter = 0;
+    /** @var int */
+    protected $filesCounter = 0;
+
+    public function __construct(IRootFolder $rootFolder, IConfig $config) {
+        parent::__construct();
+
+        $this->root = $rootFolder;
+        $this->config = $config;
+    }
+
+    protected function configure() {
+        parent::configure();
+
+        $this
+            ->setName('files:scan-app-data')
+            ->setDescription('rescan the AppData folder')
+            ->addOption(
+                'quiet',
+                'q',
+                InputOption::VALUE_NONE,
+                'suppress any output'
+            )
+            ->addOption(
+                'verbose',
+                '-v|vv|vvv',
+                InputOption::VALUE_NONE,
+                'verbose the output'
+            );
+    }
+
+    public function checkScanWarning($fullPath, OutputInterface $output) {
+        $normalizedPath = basename(\OC\Files\Filesystem::normalizePath($fullPath));
+        $path = basename($fullPath);
+
+        if ($normalizedPath !== $path) {
+            $output->writeln("\t<error>Entry \"" . $fullPath . '" will not be accessible due to incompatible encoding</error>');
+        }
+    }
+
+    protected function scanFiles($verbose, OutputInterface $output) {
+        try {
+            $appData = $this->getAppDataFolder();
+        } catch (NotFoundException $e) {
+            $output->writeln('NoAppData folder found');
+            return;
+        }
+
+        $connection = $this->reconnectToDatabase($output);
+        $scanner = new \OC\Files\Utils\Scanner(null, $connection, \OC::$server->getLogger());
+        # check on each file/folder if there was a user interrupt (ctrl-c) and throw an exception
+        # printout and count
+        if ($verbose) {
+            $scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function ($path) use ($output) {
+                $output->writeln("\tFile   <info>$path</info>");
+                $this->filesCounter += 1;
+                if ($this->hasBeenInterrupted()) {
+                    throw new InterruptedException();
+                }
+            });
+            $scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function ($path) use ($output) {
+                $output->writeln("\tFolder <info>$path</info>");
+                $this->foldersCounter += 1;
+                if ($this->hasBeenInterrupted()) {
+                    throw new InterruptedException();
+                }
+            });
+            $scanner->listen('\OC\Files\Utils\Scanner', 'StorageNotAvailable', function (StorageNotAvailableException $e) use ($output) {
+                $output->writeln("Error while scanning, storage not available (" . $e->getMessage() . ")");
+            });
+            # count only
+        } else {
+            $scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function () use ($output) {
+                $this->filesCounter += 1;
+                if ($this->hasBeenInterrupted()) {
+                    throw new InterruptedException();
+                }
+            });
+            $scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function () use ($output) {
+                $this->foldersCounter += 1;
+                if ($this->hasBeenInterrupted()) {
+                    throw new InterruptedException();
+                }
+            });
+        }
+        $scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function($path) use ($output) {
+            $this->checkScanWarning($path, $output);
+        });
+        $scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function($path) use ($output) {
+            $this->checkScanWarning($path, $output);
+        });
+
+        try {
+            $scanner->scan($appData->getPath());
+        } catch (ForbiddenException $e) {
+            $output->writeln("<error>Storage not writable</error>");
+            $output->writeln("Make sure you're running the scan command only as the user the web server runs as");
+        } catch (InterruptedException $e) {
+            # exit the function if ctrl-c has been pressed
+            $output->writeln('Interrupted by user');
+        } catch (NotFoundException $e) {
+            $output->writeln('<error>Path not found: ' . $e->getMessage() . '</error>');
+        } catch (\Exception $e) {
+            $output->writeln('<error>Exception during scan: ' . $e->getMessage() . '</error>');
+            $output->writeln('<error>' . $e->getTraceAsString() . '</error>');
+        }
+    }
+
+
+    protected function execute(InputInterface $input, OutputInterface $output) {
+        # no messaging level option means: no full printout but statistics
+        # $quiet   means no print at all
+        # $verbose means full printout including statistics
+        # -q	-v	full	stat
+        #  0	 0	no	yes
+        #  0	 1	yes	yes
+        #  1	--	no	no  (quiet overrules verbose)
+        $verbose = $input->getOption('verbose');
+        $quiet = $input->getOption('quiet');
+        # restrict the verbosity level to VERBOSITY_VERBOSE
+        if ($output->getVerbosity() > OutputInterface::VERBOSITY_VERBOSE) {
+            $output->setVerbosity(OutputInterface::VERBOSITY_VERBOSE);
+        }
+        if ($quiet) {
+            $verbose = false;
+        }
+
+        $output->writeln("\nScanning AppData for files");
+
+        $this->initTools();
+
+        $this->scanFiles($verbose, $output);
+
+        # stat: printout statistics if $quiet was not set
+        if (!$quiet) {
+            $this->presentStats($output);
+        }
+    }
+
+    /**
+     * Initialises some useful tools for the Command
+     */
+    protected function initTools() {
+        // Start the timer
+        $this->execTime = -microtime(true);
+        // Convert PHP errors to exceptions
+        set_error_handler([$this, 'exceptionErrorHandler'], E_ALL);
+    }
+
+    /**
+     * Processes PHP errors as exceptions in order to be able to keep track of problems
+     *
+     * @see https://secure.php.net/manual/en/function.set-error-handler.php
+     *
+     * @param int $severity the level of the error raised
+     * @param string $message
+     * @param string $file the filename that the error was raised in
+     * @param int $line the line number the error was raised
+     *
+     * @throws \ErrorException
+     */
+    public function exceptionErrorHandler($severity, $message, $file, $line) {
+        if (!(error_reporting() & $severity)) {
+            // This error code is not included in error_reporting
+            return;
+        }
+        throw new \ErrorException($message, 0, $severity, $file, $line);
+    }
+
+    /**
+     * @param OutputInterface $output
+     */
+    protected function presentStats(OutputInterface $output) {
+        // Stop the timer
+        $this->execTime += microtime(true);
+        $output->writeln("");
+
+        $headers = [
+            'Folders', 'Files', 'Elapsed time'
+        ];
+
+        $this->showSummary($headers, null, $output);
+    }
+
+    /**
+     * Shows a summary of operations
+     *
+     * @param string[] $headers
+     * @param string[] $rows
+     * @param OutputInterface $output
+     */
+    protected function showSummary($headers, $rows, OutputInterface $output) {
+        $niceDate = $this->formatExecTime();
+        if (!$rows) {
+            $rows = [
+                $this->foldersCounter,
+                $this->filesCounter,
+                $niceDate,
+            ];
+        }
+        $table = new Table($output);
+        $table
+            ->setHeaders($headers)
+            ->setRows([$rows]);
+        $table->render();
+    }
+
+
+    /**
+     * Formats microtime into a human readable format
+     *
+     * @return string
+     */
+    protected function formatExecTime() {
+        list($secs, ) = explode('.', sprintf("%.1f", ($this->execTime)));
+
+        # if you want to have microseconds add this:   . '.' . $tens;
+        return date('H:i:s', $secs);
+    }
+
+    /**
+     * @return \OCP\IDBConnection
+     */
+    protected function reconnectToDatabase(OutputInterface $output) {
+        /** @var Connection | IDBConnection $connection*/
+        $connection = \OC::$server->getDatabaseConnection();
+        try {
+            $connection->close();
+        } catch (\Exception $ex) {
+            $output->writeln("<info>Error while disconnecting from database: {$ex->getMessage()}</info>");
+        }
+        while (!$connection->isConnected()) {
+            try {
+                $connection->connect();
+            } catch (\Exception $ex) {
+                $output->writeln("<info>Error while re-connecting to database: {$ex->getMessage()}</info>");
+                sleep(60);
+            }
+        }
+        return $connection;
+    }
+
+    /**
+     * @return \OCP\Files\Folder
+     * @throws NotFoundException
+     */
+    private function getAppDataFolder() {
+        $instanceId = $this->config->getSystemValue('instanceid', null);
+
+        if ($instanceId === null) {
+            throw new NotFoundException();
+        }
+
+        return $this->root->get('appdata_'.$instanceId);
+    }
 }

Spacing +11 added lines, -11 removed lines

@@ -62,7 +62,7 @@ 
 		$path = basename($fullPath);
 
 		if ($normalizedPath !== $path) {
-			$output->writeln("\t<error>Entry \"" . $fullPath . '" will not be accessible due to incompatible encoding</error>');
+			$output->writeln("\t<error>Entry \"".$fullPath.'" will not be accessible due to incompatible encoding</error>');
 		}
 	}
 
@@ -79,32 +79,32 @@ 
 		# check on each file/folder if there was a user interrupt (ctrl-c) and throw an exception
 		# printout and count
 		if ($verbose) {
-			$scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function ($path) use ($output) {
+			$scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function($path) use ($output) {
 				$output->writeln("\tFile   <info>$path</info>");
 				$this->filesCounter += 1;
 				if ($this->hasBeenInterrupted()) {
 					throw new InterruptedException();
 				}
 			});
-			$scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function ($path) use ($output) {
+			$scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function($path) use ($output) {
 				$output->writeln("\tFolder <info>$path</info>");
 				$this->foldersCounter += 1;
 				if ($this->hasBeenInterrupted()) {
 					throw new InterruptedException();
 				}
 			});
-			$scanner->listen('\OC\Files\Utils\Scanner', 'StorageNotAvailable', function (StorageNotAvailableException $e) use ($output) {
-				$output->writeln("Error while scanning, storage not available (" . $e->getMessage() . ")");
+			$scanner->listen('\OC\Files\Utils\Scanner', 'StorageNotAvailable', function(StorageNotAvailableException $e) use ($output) {
+				$output->writeln("Error while scanning, storage not available (".$e->getMessage().")");
 			});
 			# count only
 		} else {
-			$scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function () use ($output) {
+			$scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function() use ($output) {
 				$this->filesCounter += 1;
 				if ($this->hasBeenInterrupted()) {
 					throw new InterruptedException();
 				}
 			});
-			$scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function () use ($output) {
+			$scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function() use ($output) {
 				$this->foldersCounter += 1;
 				if ($this->hasBeenInterrupted()) {
 					throw new InterruptedException();
@@ -127,10 +127,10 @@ 
 			# exit the function if ctrl-c has been pressed
 			$output->writeln('Interrupted by user');
 		} catch (NotFoundException $e) {
-			$output->writeln('<error>Path not found: ' . $e->getMessage() . '</error>');
+			$output->writeln('<error>Path not found: '.$e->getMessage().'</error>');
 		} catch (\Exception $e) {
-			$output->writeln('<error>Exception during scan: ' . $e->getMessage() . '</error>');
-			$output->writeln('<error>' . $e->getTraceAsString() . '</error>');
+			$output->writeln('<error>Exception during scan: '.$e->getMessage().'</error>');
+			$output->writeln('<error>'.$e->getTraceAsString().'</error>');
 		}
 	}
 
@@ -240,7 +240,7 @@ 
 	 * @return string
 	 */
 	protected function formatExecTime() {
-		list($secs, ) = explode('.', sprintf("%.1f", ($this->execTime)));
+		list($secs,) = explode('.', sprintf("%.1f", ($this->execTime)));
 
 		# if you want to have microseconds add this:   . '.' . $tens;
 		return date('H:i:s', $secs);

apps/files/lib/Command/Scan.php

Indentation +281 added lines, -281 removed lines

@@ -44,310 +44,310 @@
 
 class Scan extends Base {
 
-	/** @var IUserManager $userManager */
-	private $userManager;
-	/** @var float */
-	protected $execTime = 0;
-	/** @var int */
-	protected $foldersCounter = 0;
-	/** @var int */
-	protected $filesCounter = 0;
+    /** @var IUserManager $userManager */
+    private $userManager;
+    /** @var float */
+    protected $execTime = 0;
+    /** @var int */
+    protected $foldersCounter = 0;
+    /** @var int */
+    protected $filesCounter = 0;
 
-	public function __construct(IUserManager $userManager) {
-		$this->userManager = $userManager;
-		parent::__construct();
-	}
+    public function __construct(IUserManager $userManager) {
+        $this->userManager = $userManager;
+        parent::__construct();
+    }
 
-	protected function configure() {
-		parent::configure();
+    protected function configure() {
+        parent::configure();
 
-		$this
-			->setName('files:scan')
-			->setDescription('rescan filesystem')
-			->addArgument(
-				'user_id',
-				InputArgument::OPTIONAL | InputArgument::IS_ARRAY,
-				'will rescan all files of the given user(s)'
-			)
-			->addOption(
-				'path',
-				'p',
-				InputArgument::OPTIONAL,
-				'limit rescan to this path, eg. --path="/alice/files/Music", the user_id is determined by the path and the user_id parameter and --all are ignored'
-			)
-			->addOption(
-				'quiet',
-				'q',
-				InputOption::VALUE_NONE,
-				'suppress any output'
-			)
-			->addOption(
-				'verbose',
-				'-v|vv|vvv',
-				InputOption::VALUE_NONE,
-				'verbose the output'
-			)
-			->addOption(
-				'all',
-				null,
-				InputOption::VALUE_NONE,
-				'will rescan all files of all known users'
-			)->addOption(
-				'unscanned',
-				null,
-				InputOption::VALUE_NONE,
-				'only scan files which are marked as not fully scanned'
-			);
-	}
+        $this
+            ->setName('files:scan')
+            ->setDescription('rescan filesystem')
+            ->addArgument(
+                'user_id',
+                InputArgument::OPTIONAL | InputArgument::IS_ARRAY,
+                'will rescan all files of the given user(s)'
+            )
+            ->addOption(
+                'path',
+                'p',
+                InputArgument::OPTIONAL,
+                'limit rescan to this path, eg. --path="/alice/files/Music", the user_id is determined by the path and the user_id parameter and --all are ignored'
+            )
+            ->addOption(
+                'quiet',
+                'q',
+                InputOption::VALUE_NONE,
+                'suppress any output'
+            )
+            ->addOption(
+                'verbose',
+                '-v|vv|vvv',
+                InputOption::VALUE_NONE,
+                'verbose the output'
+            )
+            ->addOption(
+                'all',
+                null,
+                InputOption::VALUE_NONE,
+                'will rescan all files of all known users'
+            )->addOption(
+                'unscanned',
+                null,
+                InputOption::VALUE_NONE,
+                'only scan files which are marked as not fully scanned'
+            );
+    }
 
-	public function checkScanWarning($fullPath, OutputInterface $output) {
-		$normalizedPath = basename(\OC\Files\Filesystem::normalizePath($fullPath));
-		$path = basename($fullPath);
+    public function checkScanWarning($fullPath, OutputInterface $output) {
+        $normalizedPath = basename(\OC\Files\Filesystem::normalizePath($fullPath));
+        $path = basename($fullPath);
 
-		if ($normalizedPath !== $path) {
-			$output->writeln("\t<error>Entry \"" . $fullPath . '" will not be accessible due to incompatible encoding</error>');
-		}
-	}
+        if ($normalizedPath !== $path) {
+            $output->writeln("\t<error>Entry \"" . $fullPath . '" will not be accessible due to incompatible encoding</error>');
+        }
+    }
 
-	protected function scanFiles($user, $path, $verbose, OutputInterface $output, $backgroundScan = false) {
-		$connection = $this->reconnectToDatabase($output);
-		$scanner = new \OC\Files\Utils\Scanner($user, $connection, \OC::$server->getLogger());
-		# check on each file/folder if there was a user interrupt (ctrl-c) and throw an exception
-		# printout and count
-		if ($verbose) {
-			$scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function ($path) use ($output) {
-				$output->writeln("\tFile   <info>$path</info>");
-				$this->filesCounter += 1;
-				if ($this->hasBeenInterrupted()) {
-					throw new InterruptedException();
-				}
-			});
-			$scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function ($path) use ($output) {
-				$output->writeln("\tFolder <info>$path</info>");
-				$this->foldersCounter += 1;
-				if ($this->hasBeenInterrupted()) {
-					throw new InterruptedException();
-				}
-			});
-			$scanner->listen('\OC\Files\Utils\Scanner', 'StorageNotAvailable', function (StorageNotAvailableException $e) use ($output) {
-				$output->writeln("Error while scanning, storage not available (" . $e->getMessage() . ")");
-			});
-			# count only
-		} else {
-			$scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function () use ($output) {
-				$this->filesCounter += 1;
-				if ($this->hasBeenInterrupted()) {
-					throw new InterruptedException();
-				}
-			});
-			$scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function () use ($output) {
-				$this->foldersCounter += 1;
-				if ($this->hasBeenInterrupted()) {
-					throw new InterruptedException();
-				}
-			});
-		}
-		$scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function ($path) use ($output) {
-			$this->checkScanWarning($path, $output);
-		});
-		$scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function ($path) use ($output) {
-			$this->checkScanWarning($path, $output);
-		});
+    protected function scanFiles($user, $path, $verbose, OutputInterface $output, $backgroundScan = false) {
+        $connection = $this->reconnectToDatabase($output);
+        $scanner = new \OC\Files\Utils\Scanner($user, $connection, \OC::$server->getLogger());
+        # check on each file/folder if there was a user interrupt (ctrl-c) and throw an exception
+        # printout and count
+        if ($verbose) {
+            $scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function ($path) use ($output) {
+                $output->writeln("\tFile   <info>$path</info>");
+                $this->filesCounter += 1;
+                if ($this->hasBeenInterrupted()) {
+                    throw new InterruptedException();
+                }
+            });
+            $scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function ($path) use ($output) {
+                $output->writeln("\tFolder <info>$path</info>");
+                $this->foldersCounter += 1;
+                if ($this->hasBeenInterrupted()) {
+                    throw new InterruptedException();
+                }
+            });
+            $scanner->listen('\OC\Files\Utils\Scanner', 'StorageNotAvailable', function (StorageNotAvailableException $e) use ($output) {
+                $output->writeln("Error while scanning, storage not available (" . $e->getMessage() . ")");
+            });
+            # count only
+        } else {
+            $scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function () use ($output) {
+                $this->filesCounter += 1;
+                if ($this->hasBeenInterrupted()) {
+                    throw new InterruptedException();
+                }
+            });
+            $scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function () use ($output) {
+                $this->foldersCounter += 1;
+                if ($this->hasBeenInterrupted()) {
+                    throw new InterruptedException();
+                }
+            });
+        }
+        $scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function ($path) use ($output) {
+            $this->checkScanWarning($path, $output);
+        });
+        $scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function ($path) use ($output) {
+            $this->checkScanWarning($path, $output);
+        });
 
-		try {
-			if ($backgroundScan) {
-				$scanner->backgroundScan($path);
-			} else {
-				$scanner->scan($path);
-			}
-		} catch (ForbiddenException $e) {
-			$output->writeln("<error>Home storage for user $user not writable</error>");
-			$output->writeln("Make sure you're running the scan command only as the user the web server runs as");
-		} catch (InterruptedException $e) {
-			# exit the function if ctrl-c has been pressed
-			$output->writeln('Interrupted by user');
-		} catch (NotFoundException $e) {
-			$output->writeln('<error>Path not found: ' . $e->getMessage() . '</error>');
-		} catch (\Exception $e) {
-			$output->writeln('<error>Exception during scan: ' . $e->getMessage() . '</error>');
-			$output->writeln('<error>' . $e->getTraceAsString() . '</error>');
-		}
-	}
+        try {
+            if ($backgroundScan) {
+                $scanner->backgroundScan($path);
+            } else {
+                $scanner->scan($path);
+            }
+        } catch (ForbiddenException $e) {
+            $output->writeln("<error>Home storage for user $user not writable</error>");
+            $output->writeln("Make sure you're running the scan command only as the user the web server runs as");
+        } catch (InterruptedException $e) {
+            # exit the function if ctrl-c has been pressed
+            $output->writeln('Interrupted by user');
+        } catch (NotFoundException $e) {
+            $output->writeln('<error>Path not found: ' . $e->getMessage() . '</error>');
+        } catch (\Exception $e) {
+            $output->writeln('<error>Exception during scan: ' . $e->getMessage() . '</error>');
+            $output->writeln('<error>' . $e->getTraceAsString() . '</error>');
+        }
+    }
 
 
-	protected function execute(InputInterface $input, OutputInterface $output) {
-		$inputPath = $input->getOption('path');
-		if ($inputPath) {
-			$inputPath = '/' . trim($inputPath, '/');
-			list (, $user,) = explode('/', $inputPath, 3);
-			$users = array($user);
-		} else if ($input->getOption('all')) {
-			$users = $this->userManager->search('');
-		} else {
-			$users = $input->getArgument('user_id');
-		}
+    protected function execute(InputInterface $input, OutputInterface $output) {
+        $inputPath = $input->getOption('path');
+        if ($inputPath) {
+            $inputPath = '/' . trim($inputPath, '/');
+            list (, $user,) = explode('/', $inputPath, 3);
+            $users = array($user);
+        } else if ($input->getOption('all')) {
+            $users = $this->userManager->search('');
+        } else {
+            $users = $input->getArgument('user_id');
+        }
 
-		# no messaging level option means: no full printout but statistics
-		# $quiet   means no print at all
-		# $verbose means full printout including statistics
-		# -q	-v	full	stat
-		#  0	 0	no	yes
-		#  0	 1	yes	yes
-		#  1	--	no	no  (quiet overrules verbose)
-		$verbose = $input->getOption('verbose');
-		$quiet = $input->getOption('quiet');
-		# restrict the verbosity level to VERBOSITY_VERBOSE
-		if ($output->getVerbosity() > OutputInterface::VERBOSITY_VERBOSE) {
-			$output->setVerbosity(OutputInterface::VERBOSITY_VERBOSE);
-		}
-		if ($quiet) {
-			$verbose = false;
-		}
+        # no messaging level option means: no full printout but statistics
+        # $quiet   means no print at all
+        # $verbose means full printout including statistics
+        # -q	-v	full	stat
+        #  0	 0	no	yes
+        #  0	 1	yes	yes
+        #  1	--	no	no  (quiet overrules verbose)
+        $verbose = $input->getOption('verbose');
+        $quiet = $input->getOption('quiet');
+        # restrict the verbosity level to VERBOSITY_VERBOSE
+        if ($output->getVerbosity() > OutputInterface::VERBOSITY_VERBOSE) {
+            $output->setVerbosity(OutputInterface::VERBOSITY_VERBOSE);
+        }
+        if ($quiet) {
+            $verbose = false;
+        }
 
-		# check quantity of users to be process and show it on the command line
-		$users_total = count($users);
-		if ($users_total === 0) {
-			$output->writeln("<error>Please specify the user id to scan, \"--all\" to scan for all users or \"--path=...\"</error>");
-			return;
-		} else {
-			if ($users_total > 1) {
-				$output->writeln("\nScanning files for $users_total users");
-			}
-		}
+        # check quantity of users to be process and show it on the command line
+        $users_total = count($users);
+        if ($users_total === 0) {
+            $output->writeln("<error>Please specify the user id to scan, \"--all\" to scan for all users or \"--path=...\"</error>");
+            return;
+        } else {
+            if ($users_total > 1) {
+                $output->writeln("\nScanning files for $users_total users");
+            }
+        }
 
-		$this->initTools();
+        $this->initTools();
 
-		$user_count = 0;
-		foreach ($users as $user) {
-			if (is_object($user)) {
-				$user = $user->getUID();
-			}
-			$path = $inputPath ? $inputPath : '/' . $user;
-			$user_count += 1;
-			if ($this->userManager->userExists($user)) {
-				# add an extra line when verbose is set to optical separate users
-				if ($verbose) {
-					$output->writeln("");
-				}
-				$output->writeln("Starting scan for user $user_count out of $users_total ($user)");
-				# full: printout data if $verbose was set
-				$this->scanFiles($user, $path, $verbose, $output, $input->getOption('unscanned'));
-			} else {
-				$output->writeln("<error>Unknown user $user_count $user</error>");
-			}
-			# check on each user if there was a user interrupt (ctrl-c) and exit foreach
-			if ($this->hasBeenInterrupted()) {
-				break;
-			}
-		}
+        $user_count = 0;
+        foreach ($users as $user) {
+            if (is_object($user)) {
+                $user = $user->getUID();
+            }
+            $path = $inputPath ? $inputPath : '/' . $user;
+            $user_count += 1;
+            if ($this->userManager->userExists($user)) {
+                # add an extra line when verbose is set to optical separate users
+                if ($verbose) {
+                    $output->writeln("");
+                }
+                $output->writeln("Starting scan for user $user_count out of $users_total ($user)");
+                # full: printout data if $verbose was set
+                $this->scanFiles($user, $path, $verbose, $output, $input->getOption('unscanned'));
+            } else {
+                $output->writeln("<error>Unknown user $user_count $user</error>");
+            }
+            # check on each user if there was a user interrupt (ctrl-c) and exit foreach
+            if ($this->hasBeenInterrupted()) {
+                break;
+            }
+        }
 
-		# stat: printout statistics if $quiet was not set
-		if (!$quiet) {
-			$this->presentStats($output);
-		}
-	}
+        # stat: printout statistics if $quiet was not set
+        if (!$quiet) {
+            $this->presentStats($output);
+        }
+    }
 
-	/**
-	 * Initialises some useful tools for the Command
-	 */
-	protected function initTools() {
-		// Start the timer
-		$this->execTime = -microtime(true);
-		// Convert PHP errors to exceptions
-		set_error_handler([$this, 'exceptionErrorHandler'], E_ALL);
-	}
+    /**
+     * Initialises some useful tools for the Command
+     */
+    protected function initTools() {
+        // Start the timer
+        $this->execTime = -microtime(true);
+        // Convert PHP errors to exceptions
+        set_error_handler([$this, 'exceptionErrorHandler'], E_ALL);
+    }
 
-	/**
-	 * Processes PHP errors as exceptions in order to be able to keep track of problems
-	 *
-	 * @see https://secure.php.net/manual/en/function.set-error-handler.php
-	 *
-	 * @param int $severity the level of the error raised
-	 * @param string $message
-	 * @param string $file the filename that the error was raised in
-	 * @param int $line the line number the error was raised
-	 *
-	 * @throws \ErrorException
-	 */
-	public function exceptionErrorHandler($severity, $message, $file, $line) {
-		if (!(error_reporting() & $severity)) {
-			// This error code is not included in error_reporting
-			return;
-		}
-		throw new \ErrorException($message, 0, $severity, $file, $line);
-	}
+    /**
+     * Processes PHP errors as exceptions in order to be able to keep track of problems
+     *
+     * @see https://secure.php.net/manual/en/function.set-error-handler.php
+     *
+     * @param int $severity the level of the error raised
+     * @param string $message
+     * @param string $file the filename that the error was raised in
+     * @param int $line the line number the error was raised
+     *
+     * @throws \ErrorException
+     */
+    public function exceptionErrorHandler($severity, $message, $file, $line) {
+        if (!(error_reporting() & $severity)) {
+            // This error code is not included in error_reporting
+            return;
+        }
+        throw new \ErrorException($message, 0, $severity, $file, $line);
+    }
 
-	/**
-	 * @param OutputInterface $output
-	 */
-	protected function presentStats(OutputInterface $output) {
-		// Stop the timer
-		$this->execTime += microtime(true);
-		$output->writeln("");
+    /**
+     * @param OutputInterface $output
+     */
+    protected function presentStats(OutputInterface $output) {
+        // Stop the timer
+        $this->execTime += microtime(true);
+        $output->writeln("");
 
-		$headers = [
-			'Folders', 'Files', 'Elapsed time'
-		];
+        $headers = [
+            'Folders', 'Files', 'Elapsed time'
+        ];
 
-		$this->showSummary($headers, null, $output);
-	}
+        $this->showSummary($headers, null, $output);
+    }
 
-	/**
-	 * Shows a summary of operations
-	 *
-	 * @param string[] $headers
-	 * @param string[] $rows
-	 * @param OutputInterface $output
-	 */
-	protected function showSummary($headers, $rows, OutputInterface $output) {
-		$niceDate = $this->formatExecTime();
-		if (!$rows) {
-			$rows = [
-				$this->foldersCounter,
-				$this->filesCounter,
-				$niceDate,
-			];
-		}
-		$table = new Table($output);
-		$table
-			->setHeaders($headers)
-			->setRows([$rows]);
-		$table->render();
-	}
+    /**
+     * Shows a summary of operations
+     *
+     * @param string[] $headers
+     * @param string[] $rows
+     * @param OutputInterface $output
+     */
+    protected function showSummary($headers, $rows, OutputInterface $output) {
+        $niceDate = $this->formatExecTime();
+        if (!$rows) {
+            $rows = [
+                $this->foldersCounter,
+                $this->filesCounter,
+                $niceDate,
+            ];
+        }
+        $table = new Table($output);
+        $table
+            ->setHeaders($headers)
+            ->setRows([$rows]);
+        $table->render();
+    }
 
 
-	/**
-	 * Formats microtime into a human readable format
-	 *
-	 * @return string
-	 */
-	protected function formatExecTime() {
-		list($secs, ) = explode('.', sprintf("%.1f", ($this->execTime)));
+    /**
+     * Formats microtime into a human readable format
+     *
+     * @return string
+     */
+    protected function formatExecTime() {
+        list($secs, ) = explode('.', sprintf("%.1f", ($this->execTime)));
 
-		# if you want to have microseconds add this:   . '.' . $tens;
-		return date('H:i:s', $secs);
-	}
+        # if you want to have microseconds add this:   . '.' . $tens;
+        return date('H:i:s', $secs);
+    }
 
-	/**
-	 * @return \OCP\IDBConnection
-	 */
-	protected function reconnectToDatabase(OutputInterface $output) {
-		/** @var Connection | IDBConnection $connection */
-		$connection = \OC::$server->getDatabaseConnection();
-		try {
-			$connection->close();
-		} catch (\Exception $ex) {
-			$output->writeln("<info>Error while disconnecting from database: {$ex->getMessage()}</info>");
-		}
-		while (!$connection->isConnected()) {
-			try {
-				$connection->connect();
-			} catch (\Exception $ex) {
-				$output->writeln("<info>Error while re-connecting to database: {$ex->getMessage()}</info>");
-				sleep(60);
-			}
-		}
-		return $connection;
-	}
+    /**
+     * @return \OCP\IDBConnection
+     */
+    protected function reconnectToDatabase(OutputInterface $output) {
+        /** @var Connection | IDBConnection $connection */
+        $connection = \OC::$server->getDatabaseConnection();
+        try {
+            $connection->close();
+        } catch (\Exception $ex) {
+            $output->writeln("<info>Error while disconnecting from database: {$ex->getMessage()}</info>");
+        }
+        while (!$connection->isConnected()) {
+            try {
+                $connection->connect();
+            } catch (\Exception $ex) {
+                $output->writeln("<info>Error while re-connecting to database: {$ex->getMessage()}</info>");
+                sleep(60);
+            }
+        }
+        return $connection;
+    }
 
 }

Spacing +15 added lines, -15 removed lines

@@ -105,7 +105,7 @@ 
 		$path = basename($fullPath);
 
 		if ($normalizedPath !== $path) {
-			$output->writeln("\t<error>Entry \"" . $fullPath . '" will not be accessible due to incompatible encoding</error>');
+			$output->writeln("\t<error>Entry \"".$fullPath.'" will not be accessible due to incompatible encoding</error>');
 		}
 	}
 
@@ -115,42 +115,42 @@ 
 		# check on each file/folder if there was a user interrupt (ctrl-c) and throw an exception
 		# printout and count
 		if ($verbose) {
-			$scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function ($path) use ($output) {
+			$scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function($path) use ($output) {
 				$output->writeln("\tFile   <info>$path</info>");
 				$this->filesCounter += 1;
 				if ($this->hasBeenInterrupted()) {
 					throw new InterruptedException();
 				}
 			});
-			$scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function ($path) use ($output) {
+			$scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function($path) use ($output) {
 				$output->writeln("\tFolder <info>$path</info>");
 				$this->foldersCounter += 1;
 				if ($this->hasBeenInterrupted()) {
 					throw new InterruptedException();
 				}
 			});
-			$scanner->listen('\OC\Files\Utils\Scanner', 'StorageNotAvailable', function (StorageNotAvailableException $e) use ($output) {
-				$output->writeln("Error while scanning, storage not available (" . $e->getMessage() . ")");
+			$scanner->listen('\OC\Files\Utils\Scanner', 'StorageNotAvailable', function(StorageNotAvailableException $e) use ($output) {
+				$output->writeln("Error while scanning, storage not available (".$e->getMessage().")");
 			});
 			# count only
 		} else {
-			$scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function () use ($output) {
+			$scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function() use ($output) {
 				$this->filesCounter += 1;
 				if ($this->hasBeenInterrupted()) {
 					throw new InterruptedException();
 				}
 			});
-			$scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function () use ($output) {
+			$scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function() use ($output) {
 				$this->foldersCounter += 1;
 				if ($this->hasBeenInterrupted()) {
 					throw new InterruptedException();
 				}
 			});
 		}
-		$scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function ($path) use ($output) {
+		$scanner->listen('\OC\Files\Utils\Scanner', 'scanFile', function($path) use ($output) {
 			$this->checkScanWarning($path, $output);
 		});
-		$scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function ($path) use ($output) {
+		$scanner->listen('\OC\Files\Utils\Scanner', 'scanFolder', function($path) use ($output) {
 			$this->checkScanWarning($path, $output);
 		});
 
@@ -167,10 +167,10 @@ 
 			# exit the function if ctrl-c has been pressed
 			$output->writeln('Interrupted by user');
 		} catch (NotFoundException $e) {
-			$output->writeln('<error>Path not found: ' . $e->getMessage() . '</error>');
+			$output->writeln('<error>Path not found: '.$e->getMessage().'</error>');
 		} catch (\Exception $e) {
-			$output->writeln('<error>Exception during scan: ' . $e->getMessage() . '</error>');
-			$output->writeln('<error>' . $e->getTraceAsString() . '</error>');
+			$output->writeln('<error>Exception during scan: '.$e->getMessage().'</error>');
+			$output->writeln('<error>'.$e->getTraceAsString().'</error>');
 		}
 	}
 
@@ -178,7 +178,7 @@ 
 	protected function execute(InputInterface $input, OutputInterface $output) {
 		$inputPath = $input->getOption('path');
 		if ($inputPath) {
-			$inputPath = '/' . trim($inputPath, '/');
+			$inputPath = '/'.trim($inputPath, '/');
 			list (, $user,) = explode('/', $inputPath, 3);
 			$users = array($user);
 		} else if ($input->getOption('all')) {
@@ -222,7 +222,7 @@ 
 			if (is_object($user)) {
 				$user = $user->getUID();
 			}
-			$path = $inputPath ? $inputPath : '/' . $user;
+			$path = $inputPath ? $inputPath : '/'.$user;
 			$user_count += 1;
 			if ($this->userManager->userExists($user)) {
 				# add an extra line when verbose is set to optical separate users
@@ -322,7 +322,7 @@ 
 	 * @return string
 	 */
 	protected function formatExecTime() {
-		list($secs, ) = explode('.', sprintf("%.1f", ($this->execTime)));
+		list($secs,) = explode('.', sprintf("%.1f", ($this->execTime)));
 
 		# if you want to have microseconds add this:   . '.' . $tens;
 		return date('H:i:s', $secs);

lib/public/AppFramework/Db/Mapper.php

Indentation +321 added lines, -321 removed lines

@@ -37,327 +37,327 @@
  */
 abstract class Mapper {
 
-	protected $tableName;
-	protected $entityClass;
-	protected $db;
-
-	/**
-	 * @param IDBConnection $db Instance of the Db abstraction layer
-	 * @param string $tableName the name of the table. set this to allow entity
-	 * @param string $entityClass the name of the entity that the sql should be
-	 * mapped to queries without using sql
-	 * @since 7.0.0
-	 */
-	public function __construct(IDBConnection $db, $tableName, $entityClass=null){
-		$this->db = $db;
-		$this->tableName = '*PREFIX*' . $tableName;
-
-		// if not given set the entity name to the class without the mapper part
-		// cache it here for later use since reflection is slow
-		if($entityClass === null) {
-			$this->entityClass = str_replace('Mapper', '', get_class($this));
-		} else {
-			$this->entityClass = $entityClass;
-		}
-	}
-
-
-	/**
-	 * @return string the table name
-	 * @since 7.0.0
-	 */
-	public function getTableName(){
-		return $this->tableName;
-	}
-
-
-	/**
-	 * Deletes an entity from the table
-	 * @param Entity $entity the entity that should be deleted
-	 * @return Entity the deleted entity
-	 * @since 7.0.0 - return value added in 8.1.0
-	 */
-	public function delete(Entity $entity){
-		$sql = 'DELETE FROM `' . $this->tableName . '` WHERE `id` = ?';
-		$stmt = $this->execute($sql, [$entity->getId()]);
-		$stmt->closeCursor();
-		return $entity;
-	}
-
-
-	/**
-	 * Creates a new entry in the db from an entity
-	 * @param Entity $entity the entity that should be created
-	 * @return Entity the saved entity with the set id
-	 * @since 7.0.0
-	 */
-	public function insert(Entity $entity){
-		// get updated fields to save, fields have to be set using a setter to
-		// be saved
-		$properties = $entity->getUpdatedFields();
-		$values = '';
-		$columns = '';
-		$params = [];
-
-		// build the fields
-		$i = 0;
-		foreach($properties as $property => $updated) {
-			$column = $entity->propertyToColumn($property);
-			$getter = 'get' . ucfirst($property);
-
-			$columns .= '`' . $column . '`';
-			$values .= '?';
-
-			// only append colon if there are more entries
-			if($i < count($properties)-1){
-				$columns .= ',';
-				$values .= ',';
-			}
-
-			$params[] = $entity->$getter();
-			$i++;
-
-		}
-
-		$sql = 'INSERT INTO `' . $this->tableName . '`(' .
-				$columns . ') VALUES(' . $values . ')';
-
-		$stmt = $this->execute($sql, $params);
-
-		$entity->setId((int) $this->db->lastInsertId($this->tableName));
-
-		$stmt->closeCursor();
-
-		return $entity;
-	}
-
-
-
-	/**
-	 * Updates an entry in the db from an entity
-	 * @throws \InvalidArgumentException if entity has no id
-	 * @param Entity $entity the entity that should be created
-	 * @return Entity the saved entity with the set id
-	 * @since 7.0.0 - return value was added in 8.0.0
-	 */
-	public function update(Entity $entity){
-		// if entity wasn't changed it makes no sense to run a db query
-		$properties = $entity->getUpdatedFields();
-		if(count($properties) === 0) {
-			return $entity;
-		}
-
-		// entity needs an id
-		$id = $entity->getId();
-		if($id === null){
-			throw new \InvalidArgumentException(
-				'Entity which should be updated has no id');
-		}
-
-		// get updated fields to save, fields have to be set using a setter to
-		// be saved
-		// do not update the id field
-		unset($properties['id']);
-
-		$columns = '';
-		$params = [];
-
-		// build the fields
-		$i = 0;
-		foreach($properties as $property => $updated) {
-
-			$column = $entity->propertyToColumn($property);
-			$getter = 'get' . ucfirst($property);
-
-			$columns .= '`' . $column . '` = ?';
-
-			// only append colon if there are more entries
-			if($i < count($properties)-1){
-				$columns .= ',';
-			}
-
-			$params[] = $entity->$getter();
-			$i++;
-		}
-
-		$sql = 'UPDATE `' . $this->tableName . '` SET ' .
-				$columns . ' WHERE `id` = ?';
-		$params[] = $id;
-
-		$stmt = $this->execute($sql, $params);
-		$stmt->closeCursor();
-
-		return $entity;
-	}
-
-	/**
-	 * Checks if an array is associative
-	 * @param array $array
-	 * @return bool true if associative
-	 * @since 8.1.0
-	 */
-	private function isAssocArray(array $array) {
-		return array_values($array) !== $array;
-	}
-
-	/**
-	 * Returns the correct PDO constant based on the value type
-	 * @param $value
-	 * @return int PDO constant
-	 * @since 8.1.0
-	 */
-	private function getPDOType($value) {
-		switch (gettype($value)) {
-			case 'integer':
-				return \PDO::PARAM_INT;
-			case 'boolean':
-				return \PDO::PARAM_BOOL;
-			default:
-				return \PDO::PARAM_STR;
-		}
-	}
-
-
-	/**
-	 * Runs an sql query
-	 * @param string $sql the prepare string
-	 * @param array $params the params which should replace the ? in the sql query
-	 * @param int $limit the maximum number of rows
-	 * @param int $offset from which row we want to start
-	 * @return \PDOStatement the database query result
-	 * @since 7.0.0
-	 */
-	protected function execute($sql, array $params=[], $limit=null, $offset=null){
-		$query = $this->db->prepare($sql, $limit, $offset);
-
-		if ($this->isAssocArray($params)) {
-			foreach ($params as $key => $param) {
-				$pdoConstant = $this->getPDOType($param);
-				$query->bindValue($key, $param, $pdoConstant);
-			}
-		} else {
-			$index = 1;  // bindParam is 1 indexed
-			foreach ($params as $param) {
-				$pdoConstant = $this->getPDOType($param);
-				$query->bindValue($index, $param, $pdoConstant);
-				$index++;
-			}
-		}
-
-		$query->execute();
-
-		return $query;
-	}
-
-
-	/**
-	 * Returns an db result and throws exceptions when there are more or less
-	 * results
-	 * @see findEntity
-	 * @param string $sql the sql query
-	 * @param array $params the parameters of the sql query
-	 * @param int $limit the maximum number of rows
-	 * @param int $offset from which row we want to start
-	 * @throws DoesNotExistException if the item does not exist
-	 * @throws MultipleObjectsReturnedException if more than one item exist
-	 * @return array the result as row
-	 * @since 7.0.0
-	 */
-	protected function findOneQuery($sql, array $params=[], $limit=null, $offset=null){
-		$stmt = $this->execute($sql, $params, $limit, $offset);
-		$row = $stmt->fetch();
-
-		if($row === false || $row === null){
-			$stmt->closeCursor();
-			$msg = $this->buildDebugMessage(
-				'Did expect one result but found none when executing', $sql, $params, $limit, $offset
-			);
-			throw new DoesNotExistException($msg);
-		}
-		$row2 = $stmt->fetch();
-		$stmt->closeCursor();
-		//MDB2 returns null, PDO and doctrine false when no row is available
-		if( ! ($row2 === false || $row2 === null )) {
-			$msg = $this->buildDebugMessage(
-				'Did not expect more than one result when executing', $sql, $params, $limit, $offset
-			);
-			throw new MultipleObjectsReturnedException($msg);
-		} else {
-			return $row;
-		}
-	}
-
-	/**
-	 * Builds an error message by prepending the $msg to an error message which
-	 * has the parameters
-	 * @see findEntity
-	 * @param string $sql the sql query
-	 * @param array $params the parameters of the sql query
-	 * @param int $limit the maximum number of rows
-	 * @param int $offset from which row we want to start
-	 * @return string formatted error message string
-	 * @since 9.1.0
-	 */
-	private function buildDebugMessage($msg, $sql, array $params=[], $limit=null, $offset=null) {
-		return $msg .
-					': query "' .	$sql . '"; ' .
-					'parameters ' . print_r($params, true) . '; ' .
-					'limit "' . $limit . '"; '.
-					'offset "' . $offset . '"';
-	}
-
-
-	/**
-	 * Creates an entity from a row. Automatically determines the entity class
-	 * from the current mapper name (MyEntityMapper -> MyEntity)
-	 * @param array $row the row which should be converted to an entity
-	 * @return Entity the entity
-	 * @since 7.0.0
-	 */
-	protected function mapRowToEntity($row) {
-		return call_user_func($this->entityClass .'::fromRow', $row);
-	}
-
-
-	/**
-	 * Runs a sql query and returns an array of entities
-	 * @param string $sql the prepare string
-	 * @param array $params the params which should replace the ? in the sql query
-	 * @param int $limit the maximum number of rows
-	 * @param int $offset from which row we want to start
-	 * @return array all fetched entities
-	 * @since 7.0.0
-	 */
-	protected function findEntities($sql, array $params=[], $limit=null, $offset=null) {
-		$stmt = $this->execute($sql, $params, $limit, $offset);
-
-		$entities = [];
-
-		while($row = $stmt->fetch()){
-			$entities[] = $this->mapRowToEntity($row);
-		}
-
-		$stmt->closeCursor();
-
-		return $entities;
-	}
-
-
-	/**
-	 * Returns an db result and throws exceptions when there are more or less
-	 * results
-	 * @param string $sql the sql query
-	 * @param array $params the parameters of the sql query
-	 * @param int $limit the maximum number of rows
-	 * @param int $offset from which row we want to start
-	 * @throws DoesNotExistException if the item does not exist
-	 * @throws MultipleObjectsReturnedException if more than one item exist
-	 * @return Entity the entity
-	 * @since 7.0.0
-	 */
-	protected function findEntity($sql, array $params=[], $limit=null, $offset=null){
-		return $this->mapRowToEntity($this->findOneQuery($sql, $params, $limit, $offset));
-	}
+    protected $tableName;
+    protected $entityClass;
+    protected $db;
+
+    /**
+     * @param IDBConnection $db Instance of the Db abstraction layer
+     * @param string $tableName the name of the table. set this to allow entity
+     * @param string $entityClass the name of the entity that the sql should be
+     * mapped to queries without using sql
+     * @since 7.0.0
+     */
+    public function __construct(IDBConnection $db, $tableName, $entityClass=null){
+        $this->db = $db;
+        $this->tableName = '*PREFIX*' . $tableName;
+
+        // if not given set the entity name to the class without the mapper part
+        // cache it here for later use since reflection is slow
+        if($entityClass === null) {
+            $this->entityClass = str_replace('Mapper', '', get_class($this));
+        } else {
+            $this->entityClass = $entityClass;
+        }
+    }
+
+
+    /**
+     * @return string the table name
+     * @since 7.0.0
+     */
+    public function getTableName(){
+        return $this->tableName;
+    }
+
+
+    /**
+     * Deletes an entity from the table
+     * @param Entity $entity the entity that should be deleted
+     * @return Entity the deleted entity
+     * @since 7.0.0 - return value added in 8.1.0
+     */
+    public function delete(Entity $entity){
+        $sql = 'DELETE FROM `' . $this->tableName . '` WHERE `id` = ?';
+        $stmt = $this->execute($sql, [$entity->getId()]);
+        $stmt->closeCursor();
+        return $entity;
+    }
+
+
+    /**
+     * Creates a new entry in the db from an entity
+     * @param Entity $entity the entity that should be created
+     * @return Entity the saved entity with the set id
+     * @since 7.0.0
+     */
+    public function insert(Entity $entity){
+        // get updated fields to save, fields have to be set using a setter to
+        // be saved
+        $properties = $entity->getUpdatedFields();
+        $values = '';
+        $columns = '';
+        $params = [];
+
+        // build the fields
+        $i = 0;
+        foreach($properties as $property => $updated) {
+            $column = $entity->propertyToColumn($property);
+            $getter = 'get' . ucfirst($property);
+
+            $columns .= '`' . $column . '`';
+            $values .= '?';
+
+            // only append colon if there are more entries
+            if($i < count($properties)-1){
+                $columns .= ',';
+                $values .= ',';
+            }
+
+            $params[] = $entity->$getter();
+            $i++;
+
+        }
+
+        $sql = 'INSERT INTO `' . $this->tableName . '`(' .
+                $columns . ') VALUES(' . $values . ')';
+
+        $stmt = $this->execute($sql, $params);
+
+        $entity->setId((int) $this->db->lastInsertId($this->tableName));
+
+        $stmt->closeCursor();
+
+        return $entity;
+    }
+
+
+
+    /**
+     * Updates an entry in the db from an entity
+     * @throws \InvalidArgumentException if entity has no id
+     * @param Entity $entity the entity that should be created
+     * @return Entity the saved entity with the set id
+     * @since 7.0.0 - return value was added in 8.0.0
+     */
+    public function update(Entity $entity){
+        // if entity wasn't changed it makes no sense to run a db query
+        $properties = $entity->getUpdatedFields();
+        if(count($properties) === 0) {
+            return $entity;
+        }
+
+        // entity needs an id
+        $id = $entity->getId();
+        if($id === null){
+            throw new \InvalidArgumentException(
+                'Entity which should be updated has no id');
+        }
+
+        // get updated fields to save, fields have to be set using a setter to
+        // be saved
+        // do not update the id field
+        unset($properties['id']);
+
+        $columns = '';
+        $params = [];
+
+        // build the fields
+        $i = 0;
+        foreach($properties as $property => $updated) {
+
+            $column = $entity->propertyToColumn($property);
+            $getter = 'get' . ucfirst($property);
+
+            $columns .= '`' . $column . '` = ?';
+
+            // only append colon if there are more entries
+            if($i < count($properties)-1){
+                $columns .= ',';
+            }
+
+            $params[] = $entity->$getter();
+            $i++;
+        }
+
+        $sql = 'UPDATE `' . $this->tableName . '` SET ' .
+                $columns . ' WHERE `id` = ?';
+        $params[] = $id;
+
+        $stmt = $this->execute($sql, $params);
+        $stmt->closeCursor();
+
+        return $entity;
+    }
+
+    /**
+     * Checks if an array is associative
+     * @param array $array
+     * @return bool true if associative
+     * @since 8.1.0
+     */
+    private function isAssocArray(array $array) {
+        return array_values($array) !== $array;
+    }
+
+    /**
+     * Returns the correct PDO constant based on the value type
+     * @param $value
+     * @return int PDO constant
+     * @since 8.1.0
+     */
+    private function getPDOType($value) {
+        switch (gettype($value)) {
+            case 'integer':
+                return \PDO::PARAM_INT;
+            case 'boolean':
+                return \PDO::PARAM_BOOL;
+            default:
+                return \PDO::PARAM_STR;
+        }
+    }
+
+
+    /**
+     * Runs an sql query
+     * @param string $sql the prepare string
+     * @param array $params the params which should replace the ? in the sql query
+     * @param int $limit the maximum number of rows
+     * @param int $offset from which row we want to start
+     * @return \PDOStatement the database query result
+     * @since 7.0.0
+     */
+    protected function execute($sql, array $params=[], $limit=null, $offset=null){
+        $query = $this->db->prepare($sql, $limit, $offset);
+
+        if ($this->isAssocArray($params)) {
+            foreach ($params as $key => $param) {
+                $pdoConstant = $this->getPDOType($param);
+                $query->bindValue($key, $param, $pdoConstant);
+            }
+        } else {
+            $index = 1;  // bindParam is 1 indexed
+            foreach ($params as $param) {
+                $pdoConstant = $this->getPDOType($param);
+                $query->bindValue($index, $param, $pdoConstant);
+                $index++;
+            }
+        }
+
+        $query->execute();
+
+        return $query;
+    }
+
+
+    /**
+     * Returns an db result and throws exceptions when there are more or less
+     * results
+     * @see findEntity
+     * @param string $sql the sql query
+     * @param array $params the parameters of the sql query
+     * @param int $limit the maximum number of rows
+     * @param int $offset from which row we want to start
+     * @throws DoesNotExistException if the item does not exist
+     * @throws MultipleObjectsReturnedException if more than one item exist
+     * @return array the result as row
+     * @since 7.0.0
+     */
+    protected function findOneQuery($sql, array $params=[], $limit=null, $offset=null){
+        $stmt = $this->execute($sql, $params, $limit, $offset);
+        $row = $stmt->fetch();
+
+        if($row === false || $row === null){
+            $stmt->closeCursor();
+            $msg = $this->buildDebugMessage(
+                'Did expect one result but found none when executing', $sql, $params, $limit, $offset
+            );
+            throw new DoesNotExistException($msg);
+        }
+        $row2 = $stmt->fetch();
+        $stmt->closeCursor();
+        //MDB2 returns null, PDO and doctrine false when no row is available
+        if( ! ($row2 === false || $row2 === null )) {
+            $msg = $this->buildDebugMessage(
+                'Did not expect more than one result when executing', $sql, $params, $limit, $offset
+            );
+            throw new MultipleObjectsReturnedException($msg);
+        } else {
+            return $row;
+        }
+    }
+
+    /**
+     * Builds an error message by prepending the $msg to an error message which
+     * has the parameters
+     * @see findEntity
+     * @param string $sql the sql query
+     * @param array $params the parameters of the sql query
+     * @param int $limit the maximum number of rows
+     * @param int $offset from which row we want to start
+     * @return string formatted error message string
+     * @since 9.1.0
+     */
+    private function buildDebugMessage($msg, $sql, array $params=[], $limit=null, $offset=null) {
+        return $msg .
+                    ': query "' .	$sql . '"; ' .
+                    'parameters ' . print_r($params, true) . '; ' .
+                    'limit "' . $limit . '"; '.
+                    'offset "' . $offset . '"';
+    }
+
+
+    /**
+     * Creates an entity from a row. Automatically determines the entity class
+     * from the current mapper name (MyEntityMapper -> MyEntity)
+     * @param array $row the row which should be converted to an entity
+     * @return Entity the entity
+     * @since 7.0.0
+     */
+    protected function mapRowToEntity($row) {
+        return call_user_func($this->entityClass .'::fromRow', $row);
+    }
+
+
+    /**
+     * Runs a sql query and returns an array of entities
+     * @param string $sql the prepare string
+     * @param array $params the params which should replace the ? in the sql query
+     * @param int $limit the maximum number of rows
+     * @param int $offset from which row we want to start
+     * @return array all fetched entities
+     * @since 7.0.0
+     */
+    protected function findEntities($sql, array $params=[], $limit=null, $offset=null) {
+        $stmt = $this->execute($sql, $params, $limit, $offset);
+
+        $entities = [];
+
+        while($row = $stmt->fetch()){
+            $entities[] = $this->mapRowToEntity($row);
+        }
+
+        $stmt->closeCursor();
+
+        return $entities;
+    }
+
+
+    /**
+     * Returns an db result and throws exceptions when there are more or less
+     * results
+     * @param string $sql the sql query
+     * @param array $params the parameters of the sql query
+     * @param int $limit the maximum number of rows
+     * @param int $offset from which row we want to start
+     * @throws DoesNotExistException if the item does not exist
+     * @throws MultipleObjectsReturnedException if more than one item exist
+     * @return Entity the entity
+     * @since 7.0.0
+     */
+    protected function findEntity($sql, array $params=[], $limit=null, $offset=null){
+        return $this->mapRowToEntity($this->findOneQuery($sql, $params, $limit, $offset));
+    }
 
 
 }