Skip to content

make NextCloud WORM file system friendly #24596

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
PVince81 merged 3 commits into from
Sep 16, 2022
Merged

make NextCloud WORM file system friendly #24596

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b6065a2
files: make OC\Files\Storage\Local WORM friendly
kofemann Dec 7, 2020
8fc4cf6
files: remove destination file before copying new content (WORM)
kofemann Mar 7, 2022
f41209a
config: add a switch to control truncate before update
kofemann Mar 31, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
config: add a switch to control truncate before update 
To avoid extra truncate on non WORM file systems, add a new config
option `localstorage.unlink_on_truncate`, which defaults to false.

The OC\Files\Storage\Local is update to respect that option.

Signed-off-by: Tigran Mkrtchyan <[email protected]>
  • Loading branch information
@kofemann
kofemann committed Sep 16, 2022
commit f41209a0614a317857b77d3be80cd7ef4dbb4695
8 changes: 8 additions & 0 deletions config/config.sample.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1887,6 +1887,14 @@
*/
'localstorage.umask' => 0022,

/**
* This options allows storage systems that don't allow to modify existing files
* to overcome this limitation by removing the files before overwriting.
*
* Defaults to ``false``
*/
'localstorage.unlink_on_truncate' => false,

/**
* EXPERIMENTAL: option whether to include external storage in quota
* calculation, defaults to false.
Expand Down
18 changes: 12 additions & 6 deletions lib/private/Files/Storage/Local.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,8 @@ class Local extends \OC\Files\Storage\Common {

private $defUMask;

protected bool $unlinkOnTruncate;

public function __construct($arguments) {
if (!isset($arguments['datadir']) || !is_string($arguments['datadir'])) {
throw new \InvalidArgumentException('No data directory set for local storage');
Expand All @@ -88,6 +90,9 @@ public function __construct($arguments) {
$this->config = \OC::$server->get(IConfig::class);
$this->mimeTypeDetector = \OC::$server->get(IMimeTypeDetector::class);
$this->defUMask = $this->config->getSystemValue('localstorage.umask', 0022);

// support Write-Once-Read-Many file systems
$this->unlinkOnTruncate = $this->config->getSystemValue('localstorage.unlink_on_truncate', false);
}

public function __destruct() {
Expand Down Expand Up @@ -297,8 +302,9 @@ public function file_get_contents($path) {

public function file_put_contents($path, $data) {
$oldMask = umask($this->defUMask);
// support Write-Once-Read-Many filesystems
$this->unlink($path);
if ($this->unlinkOnTruncate) {
$this->unlink($path);
}
$result = file_put_contents($this->getSourcePath($path), $data);
umask($oldMask);
return $result;
Expand Down Expand Up @@ -372,8 +378,9 @@ public function copy($path1, $path2) {
return parent::copy($path1, $path2);
} else {
$oldMask = umask($this->defUMask);
// support Write-Once-Read-Many filesystems
$this->unlink($path2);
if ($this->unlinkOnTruncate) {
$this->unlink($path2);
}
$result = copy($this->getSourcePath($path1), $this->getSourcePath($path2));
umask($oldMask);
return $result;
Expand All @@ -382,8 +389,7 @@ public function copy($path1, $path2) {

public function fopen($path, $mode) {
$oldMask = umask($this->defUMask);
if ($mode === 'w') {
// support Write-Once-Read-Many filesystems
if (($mode === 'w' || $mode === 'w+') && $this->unlinkOnTruncate) {
$this->unlink($path);
}
$result = fopen($this->getSourcePath($path), $mode);
Expand Down