-
-
Notifications
You must be signed in to change notification settings - Fork 35k
fs,doc,test: open reserved characters under win32 #13875
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.
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
Changes from 2 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -1587,6 +1587,26 @@ fs.open('<directory>', 'a+', (err, fd) => { | |
| }); | ||
| ``` | ||
|
|
||
| Some characters are reserved under Windows as documented by | ||
| [Naming Files, Paths, and Namespaces][]. Under NTFS, if the filename contains | ||
| colon, Node.js will open a file system stream, as described by | ||
| [this MSDN page][MSDN-Using-Streams]. | ||
|
|
||
| The reserved characters are list below. | ||
|
|
||
| + `<` (less than) | ||
|
||
| + `>` (greater than) | ||
| + `:` (colon) | ||
| + `"` (double quote) | ||
| + `/` (forward slash) | ||
| + `\` (backslash) | ||
| + `|` (vertical bar or pipe) | ||
| + `?` (question mark) | ||
| + `*` (asterisk) | ||
|
|
||
| Functions based on `fs.open()` exhibit this behavior as well. eg. | ||
| `fs.writeFile()`, `fs.readFile()`, etc. | ||
|
|
||
| ## fs.openSync(path, flags[, mode]) | ||
| <!-- YAML | ||
| added: v0.1.21 | ||
|
|
@@ -2864,3 +2884,5 @@ The following constants are meant for use with the [`fs.Stats`][] object's | |
| [Readable Stream]: stream.html#stream_class_stream_readable | ||
| [Writable Stream]: stream.html#stream_class_stream_writable | ||
| [inode]: https://en.wikipedia.org/wiki/Inode | ||
| [Naming Files, Paths, and Namespaces]: https://msdn.microsoft.com/en-us/library/windows/desktop/aa365247(v=vs.85).aspx | ||
| [MSDN-Using-Streams]: https://msdn.microsoft.com/en-us/library/windows/desktop/bb540537.aspx | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| 'use strict'; | ||
|
|
||
| const common = require('../common'); | ||
| const assert = require('assert'); | ||
| const fs = require('fs'); | ||
| const path = require('path'); | ||
|
|
||
| if (!common.isWindows) | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Maybe the skipping can be placed before
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think all |
||
| common.skip('This test is for Windows only.'); | ||
|
|
||
| common.refreshTmpDir(); | ||
|
|
||
| const DATA_VALUE = 'hello'; | ||
|
|
||
| // Refs: https://msdn.microsoft.com/en-us/library/windows/desktop/aa365247(v=vs.85).aspx | ||
| // Ignore '/', '\\' and ':' | ||
| const REVERSED_CHARACTERS = '<>"|?*'; | ||
|
||
|
|
||
| Array.prototype.forEach.call(REVERSED_CHARACTERS, (ch) => { | ||
|
||
| const pathname = path.join(common.tmpDir, `somefile_${ch}`); | ||
| assert.throws( | ||
| () => { | ||
| fs.writeFileSync(pathname, DATA_VALUE); | ||
| }, | ||
| /^Error: ENOENT: no such file or directory, open '.*'$/, | ||
| `failed with '${ch}'`); | ||
|
||
| }); | ||
|
|
||
| // Test for ':' (NTFS data streams). | ||
| // Refs: https://msdn.microsoft.com/en-us/library/windows/desktop/bb540537.aspx | ||
| const pathname = path.join(common.tmpDir, 'foo:bar'); | ||
| fs.writeFileSync(pathname, DATA_VALUE); | ||
|
|
||
| let content = ''; | ||
| const fileDataStream = fs.createReadStream(pathname, { | ||
| encoding: 'utf8' | ||
| }); | ||
|
|
||
| fileDataStream.on('data', (data) => { | ||
| content += data.toString(); | ||
|
||
| }); | ||
|
|
||
| fileDataStream.on('end', common.mustCall(() => { | ||
| assert.strictEqual(content, DATA_VALUE); | ||
| })); | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"colon" -> "a colon"