php / php/php-src

Consistent support for NTFS streams

Open
#9,230 0 comments 3 reactions 1 assignee View on GitHub

@cmb69 is already working on this.

Since Aug 2, 2022.

  • #9231 by @cmb69 — open
Category: Streams Feature OS: Windows Status: Needs Triage
Dominant language
C
Stars
40.4k
Forks
8.1k
Avg merge
2d 13h
Merged PRs (30d)
96

Description

Description

The following code:

<?php
$filename = __DIR__ . "/ntfs.txt:foo";
var_dump(file_put_contents($filename, "bar"));
var_dump(file_get_contents($filename));
var_dump(file_exists($filename));
var_dump(realpath($filename));
var_dump(@stat($filename) !== false);
var_dump(basename($filename));
var_dump(file_exists(basename($filename)));

Resulted in this output for NTS builds:

int(3)
string(3) "bar"
bool(true)
bool(false)
bool(true)
string(12) "ntfs.txt:foo"
bool(false)

Resulted in this output for ZTS builds:

int(3)
string(3) "bar"
bool(false)
bool(false)
bool(false)
string(12) "ntfs.txt:foo"
bool(false)

As shown, the support for NTFS streams is totally inconsistent. Reading and writing such streams is supported, but file_exists() and stat() behave differently for NTS and ZTS builds (and even differently for NTS streams depending on whether an absolute or relative path is given). realpath() always fails.

Furthermore, pathinfo() and friends report the stream name as part of the filename, usually even as part of the file extension.

This (dangerous) inconsistency should be resolved one way or another. It might be best to completely remove support for NTFS streams for plain files, mostly to be consistent with other systems, and to avoid confusion for userland developers. A simple solution would be to "reject" such filenames, i.e. report permission denied when trying to access them. If we do this, pathinfo() and friends can likely stay as is.

If support for NTFS streams is desireable, we could introduce a new stream wrapper (say ntfs://) which would make NTFS stream access explicit.

PHP Version

all supported versions

Operating System

Windows

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.