-
-
Notifications
You must be signed in to change notification settings - Fork 4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #19493 from nextcloud/simplefile-new-lazy
Create SimpleFile only when writing the content
- Loading branch information
Showing
10 changed files
with
293 additions
and
81 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,221 @@ | ||
<?php declare(strict_types=1); | ||
/** | ||
* @copyright Copyright (c) 2020 Robin Appelman <[email protected]> | ||
* | ||
* @license GNU AGPL version 3 or any later version | ||
* | ||
* This program is free software: you can redistribute it and/or modify | ||
* it under the terms of the GNU Affero General Public License as | ||
* published by the Free Software Foundation, either version 3 of the | ||
* License, or (at your option) any later version. | ||
* | ||
* This program is distributed in the hope that it will be useful, | ||
* but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
* GNU Affero General Public License for more details. | ||
* | ||
* You should have received a copy of the GNU Affero General Public License | ||
* along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
* | ||
*/ | ||
|
||
namespace OC\Files\SimpleFS; | ||
|
||
use Icewind\Streams\CallbackWrapper; | ||
use OCP\Files\File; | ||
use OCP\Files\Folder; | ||
use OCP\Files\NotFoundException; | ||
use OCP\Files\NotPermittedException; | ||
use OCP\Files\SimpleFS\ISimpleFile; | ||
|
||
class NewSimpleFile implements ISimpleFile { | ||
private $parentFolder; | ||
private $name; | ||
/** @var File|null */ | ||
private $file = null; | ||
|
||
/** | ||
* File constructor. | ||
* | ||
* @param File $file | ||
*/ | ||
public function __construct(Folder $parentFolder, string $name) { | ||
$this->parentFolder = $parentFolder; | ||
$this->name = $name; | ||
} | ||
|
||
/** | ||
* Get the name | ||
* | ||
* @return string | ||
*/ | ||
public function getName() { | ||
return $this->name; | ||
} | ||
|
||
/** | ||
* Get the size in bytes | ||
* | ||
* @return int | ||
*/ | ||
public function getSize() { | ||
if ($this->file) { | ||
return $this->file->getSize(); | ||
} else { | ||
return 0; | ||
} | ||
} | ||
|
||
/** | ||
* Get the ETag | ||
* | ||
* @return string | ||
*/ | ||
public function getETag() { | ||
if ($this->file) { | ||
return $this->file->getEtag(); | ||
} else { | ||
return ''; | ||
} | ||
} | ||
|
||
/** | ||
* Get the last modification time | ||
* | ||
* @return int | ||
*/ | ||
public function getMTime() { | ||
if ($this->file) { | ||
return $this->file->getMTime(); | ||
} else { | ||
return time(); | ||
} | ||
} | ||
|
||
/** | ||
* Get the content | ||
* | ||
* @return string | ||
* @throws NotFoundException | ||
* @throws NotPermittedException | ||
*/ | ||
public function getContent() { | ||
if ($this->file) { | ||
$result = $this->file->getContent(); | ||
|
||
if ($result === false) { | ||
$this->checkFile(); | ||
} | ||
|
||
return $result; | ||
} else { | ||
return ''; | ||
} | ||
} | ||
|
||
/** | ||
* Overwrite the file | ||
* | ||
* @param string|resource $data | ||
* @throws NotPermittedException | ||
* @throws NotFoundException | ||
*/ | ||
public function putContent($data) { | ||
try { | ||
if ($this->file) { | ||
$this->file->putContent($data); | ||
} else { | ||
$this->file = $this->parentFolder->newFile($this->name, $data); | ||
} | ||
} catch (NotFoundException $e) { | ||
$this->checkFile(); | ||
} | ||
} | ||
|
||
/** | ||
* Sometimes there are some issues with the AppData. Most of them are from | ||
* user error. But we should handle them gracefull anyway. | ||
* | ||
* If for some reason the current file can't be found. We remove it. | ||
* Then traverse up and check all folders if they exists. This so that the | ||
* next request will have a valid appdata structure again. | ||
* | ||
* @throws NotFoundException | ||
*/ | ||
private function checkFile() { | ||
$cur = $this->file; | ||
|
||
while ($cur->stat() === false) { | ||
$parent = $cur->getParent(); | ||
try { | ||
$cur->delete(); | ||
} catch (NotFoundException $e) { | ||
// Just continue then | ||
} | ||
$cur = $parent; | ||
} | ||
|
||
if ($cur !== $this->file) { | ||
throw new NotFoundException('File does not exist'); | ||
} | ||
} | ||
|
||
|
||
/** | ||
* Delete the file | ||
* | ||
* @throws NotPermittedException | ||
*/ | ||
public function delete() { | ||
if ($this->file) { | ||
$this->file->delete(); | ||
} | ||
} | ||
|
||
/** | ||
* Get the MimeType | ||
* | ||
* @return string | ||
*/ | ||
public function getMimeType() { | ||
if ($this->file) { | ||
return $this->file->getMimeType(); | ||
} else { | ||
return 'text/plain'; | ||
} | ||
} | ||
|
||
/** | ||
* Open the file as stream for reading, resulting resource can be operated as stream like the result from php's own fopen | ||
* | ||
* @return resource | ||
* @throws \OCP\Files\NotPermittedException | ||
* @since 14.0.0 | ||
*/ | ||
public function read() { | ||
if ($this->file) { | ||
return $this->file->fopen('r'); | ||
} else { | ||
return fopen('php://temp', 'r'); | ||
} | ||
} | ||
|
||
/** | ||
* Open the file as stream for writing, resulting resource can be operated as stream like the result from php's own fopen | ||
* | ||
* @return resource | ||
* @throws \OCP\Files\NotPermittedException | ||
* @since 14.0.0 | ||
*/ | ||
public function write() { | ||
if ($this->file) { | ||
return $this->file->fopen('w'); | ||
} else { | ||
$source = fopen('php://temp', 'w+'); | ||
return CallbackWrapper::wrap($source, null, null, null, null, function () use ($source) { | ||
rewind($source); | ||
$this->putContent($source); | ||
}); | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.