Merge pull request #37943 from nextcloud/fix/fix-getcontent-return-type

Fix file_get_content signatures to make it clear it can return false
nextcloud · May 3, 2023 · 997efe4 · 997efe4
2 parents 7fcf42a + 546d94c
commit 997efe4
Show file tree

Hide file tree

Showing 10 changed files with 16 additions and 13 deletions.
diff --git a/lib/private/Files/Filesystem.php b/lib/private/Files/Filesystem.php
@@ -554,7 +554,7 @@ public static function touch($path, $mtime = null) {
 	}
 
 	/**
-	 * @return string
+	 * @return string|false
 	 */
 	public static function file_get_contents($path) {
 		return self::$defaultInstance->file_get_contents($path);

diff --git a/lib/private/Files/Node/File.php b/lib/private/Files/Node/File.php
@@ -46,14 +46,16 @@ protected function createNonExistingNode($path) {
 	/**
 	 * @return string
 	 * @throws NotPermittedException
+	 * @throws GenericFileException
 	 * @throws LockedException
 	 */
 	public function getContent() {
 		if ($this->checkPermissions(\OCP\Constants::PERMISSION_READ)) {
-			/**
-			 * @var \OC\Files\Storage\Storage $storage;
-			 */
-			return $this->view->file_get_contents($this->path);
+			$content = $this->view->file_get_contents($this->path);
+			if ($content === false) {
+				throw new GenericFileException();
+			}
+			return $content;
 		} else {
 			throw new NotPermittedException();
 		}
@@ -62,7 +64,7 @@ public function getContent() {
 	/**
 	 * @param string|resource $data
 	 * @throws NotPermittedException
-	 * @throws \OCP\Files\GenericFileException
+	 * @throws GenericFileException
 	 * @throws LockedException
 	 */
 	public function putContent($data) {

diff --git a/lib/private/Files/Storage/Wrapper/Encoding.php b/lib/private/Files/Storage/Wrapper/Encoding.php
@@ -300,7 +300,7 @@ public function filemtime($path) {
 	 * see https://www.php.net/manual/en/function.file_get_contents.php
 	 *
 	 * @param string $path
-	 * @return string|bool
+	 * @return string|false
 	 */
 	public function file_get_contents($path) {
 		return $this->storage->file_get_contents($this->findPathToUse($path));

diff --git a/lib/private/Files/Storage/Wrapper/Encryption.php b/lib/private/Files/Storage/Wrapper/Encryption.php
@@ -217,7 +217,7 @@ public function getDirectoryContent($directory): \Traversable {
 	 * see https://www.php.net/manual/en/function.file_get_contents.php
 	 *
 	 * @param string $path
-	 * @return string
+	 * @return string|false
 	 */
 	public function file_get_contents($path) {
 		$encryptionModule = $this->getEncryptionModule($path);

diff --git a/lib/private/Files/Storage/Wrapper/Jail.php b/lib/private/Files/Storage/Wrapper/Jail.php
@@ -248,7 +248,7 @@ public function filemtime($path) {
 	 * see https://www.php.net/manual/en/function.file_get_contents.php
 	 *
 	 * @param string $path
-	 * @return string|bool
+	 * @return string|false
 	 */
 	public function file_get_contents($path) {
 		return $this->getWrapperStorage()->file_get_contents($this->getUnjailedPath($path));

diff --git a/lib/private/Files/Storage/Wrapper/Wrapper.php b/lib/private/Files/Storage/Wrapper/Wrapper.php
@@ -238,7 +238,7 @@ public function filemtime($path) {
 	 * see https://www.php.net/manual/en/function.file_get_contents.php
 	 *
 	 * @param string $path
-	 * @return string|bool
+	 * @return string|false
 	 */
 	public function file_get_contents($path) {
 		return $this->getWrapperStorage()->file_get_contents($path);

diff --git a/lib/private/Files/View.php b/lib/private/Files/View.php
@@ -564,7 +564,7 @@ public function touch($path, $mtime = null): bool {
 
 	/**
 	 * @param string $path
-	 * @return mixed
+	 * @return string|false
 	 * @throws LockedException
 	 */
 	public function file_get_contents($path) {

diff --git a/lib/public/Files/File.php b/lib/public/Files/File.php
@@ -40,6 +40,7 @@ interface File extends Node {
 	 *
 	 * @return string
 	 * @throws NotPermittedException
+	 * @throws GenericFileException
 	 * @throws LockedException
 	 * @since 6.0.0
 	 */

diff --git a/lib/public/Files/Storage.php b/lib/public/Files/Storage.php
@@ -217,7 +217,7 @@ public function filemtime($path);
 	 * see https://www.php.net/manual/en/function.file_get_contents.php
 	 *
 	 * @param string $path
-	 * @return string|bool
+	 * @return string|false
 	 * @since 6.0.0
 	 */
 	public function file_get_contents($path);

diff --git a/lib/public/Files/Storage/IStorage.php b/lib/public/Files/Storage/IStorage.php
@@ -214,7 +214,7 @@ public function filemtime($path);
 	 * see https://www.php.net/manual/en/function.file_get_contents.php
 	 *
 	 * @param string $path
-	 * @return string|bool
+	 * @return string|false
 	 * @since 9.0.0
 	 */
 	public function file_get_contents($path);