Avoid reserved Windows filenames like AUX, NUL, PRN and COM1

david-04 · Apr 23, 2022 · 036ff22 · 036ff22
1 parent 068b00a
commit 036ff22
Show file tree

Hide file tree

Showing 5 changed files with 76 additions and 14 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Change Log
 
+## [1.0.2](https://github.com/david-04/7-sync/releases/tag/v1.0.2) (2022-04-23)
+
+- Avoid Windows reserved filenames (e.g. `PRN`, `AUX`, `NUL`, `COM1`, ...)
+
 ## [1.0.1](https://github.com/david-04/7-sync/releases/tag/v1.0.1) (2022-04-15)
 
 - Fixed link to CHANGELOG

diff --git a/package/7-sync.js b/package/7-sync.js
@@ -98,7 +98,7 @@ process.on("beforeExit", () => {
         Application.main();
     }
 });
-const APPLICATION_VERSION = "1.0.1";
+const APPLICATION_VERSION = "1.0.2";
 const COPYRIGHT_OWNER = "David Hofmann";
 const COPYRIGHT_YEARS = "2022";
 class Context {
@@ -1127,17 +1127,20 @@ class FilenameEnumerator {
             next = next ? this.calculateNext(next) : this.firstLetter;
             const filename = prefix + next + suffix;
             const filenameWithPath = node.path.join(path, filename);
-            if (FileUtils.exists(filenameWithPath)) {
-                this.logger.warn(`The next filename is already occupied: ${path} => ${filename}`);
-            }
-            else if (!MetadataManager.isMetadataArchiveName(next)) {
-                return { enumeratedName: next, filename, filenameWithPath };
+            if (!FilenameEnumerator.RESERVED_NAMES.has(next.toLowerCase())) {
+                if (FileUtils.exists(filenameWithPath)) {
+                    this.logger.warn(`The next filename is already occupied: ${path} => ${filename}`);
+                }
+                else if (!MetadataManager.isMetadataArchiveName(next)) {
+                    return { enumeratedName: next, filename, filenameWithPath };
+                }
             }
         }
     }
     recalculateLastFilename(last, filenames) {
+        const ext = ".7z";
         return filenames
-            .map(filename => filename.endsWith(".7z") ? filename.substring(0, filename.length - 3) : filename)
+            .map(filename => filename.endsWith(ext) ? filename.substring(0, filename.length - ext.length) : filename)
             .filter(basename => this.isEnumeratedName(basename))
             .reduce((a, b) => this.getLastFilename(a, b), this.isEnumeratedName(last) ? last : "");
     }
@@ -1176,6 +1179,32 @@ class FilenameEnumerator {
     }
 }
 FilenameEnumerator.LETTERS = "abcdefghijkmnpqrstuvwxyz123456789";
+FilenameEnumerator.RESERVED_NAMES = new Set([
+    "CON",
+    "PRN",
+    "AUX",
+    "NUL",
+    "COM1",
+    "COM2",
+    "COM3",
+    "COM4",
+    "COM5",
+    "COM6",
+    "COM7",
+    "COM8",
+    "COM9",
+    "COM0",
+    "LPT1",
+    "LPT2",
+    "LPT3",
+    "LPT4",
+    "LPT5",
+    "LPT6",
+    "LPT7",
+    "LPT8",
+    "LPT9",
+    "LPT0"
+].map(name => name.toLowerCase()));
 var _a;
 class InteractivePrompt {
     static prompt(options) {

diff --git a/package/package.json b/package/package.json
@@ -1,6 +1,6 @@
 {
   "name": "7-sync",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "A wrapper for 7-Zip to create cloud-friendly encrypted backups",
   "main": "index.js",
   "repository": {

diff --git a/src/features/filename-enumerator.ts b/src/features/filename-enumerator.ts
@@ -5,6 +5,32 @@
 class FilenameEnumerator {
 
     private static readonly LETTERS = "abcdefghijkmnpqrstuvwxyz123456789"; // cspell: disable-line
+    private static readonly RESERVED_NAMES = new Set([
+        "CON",
+        "PRN",
+        "AUX",
+        "NUL",
+        "COM1",
+        "COM2",
+        "COM3",
+        "COM4",
+        "COM5",
+        "COM6",
+        "COM7",
+        "COM8",
+        "COM9",
+        "COM0",
+        "LPT1",
+        "LPT2",
+        "LPT3",
+        "LPT4",
+        "LPT5",
+        "LPT6",
+        "LPT7",
+        "LPT8",
+        "LPT9",
+        "LPT0"
+    ].map(name => name.toLowerCase()));
 
     private readonly firstLetter;
     private readonly nextLetter;
@@ -99,10 +125,12 @@ class FilenameEnumerator {
             next = next ? this.calculateNext(next) : this.firstLetter;
             const filename = prefix + next + suffix;
             const filenameWithPath = node.path.join(path, filename);
-            if (FileUtils.exists(filenameWithPath)) {
-                this.logger.warn(`The next filename is already occupied: ${path} => ${filename}`);
-            } else if (!MetadataManager.isMetadataArchiveName(next)) {
-                return { enumeratedName: next, filename, filenameWithPath };
+            if (!FilenameEnumerator.RESERVED_NAMES.has(next.toLowerCase())) {
+                if (FileUtils.exists(filenameWithPath)) {
+                    this.logger.warn(`The next filename is already occupied: ${path} => ${filename}`);
+                } else if (!MetadataManager.isMetadataArchiveName(next)) {
+                    return { enumeratedName: next, filename, filenameWithPath };
+                }
             }
         }
     }
@@ -112,8 +140,9 @@ class FilenameEnumerator {
     //------------------------------------------------------------------------------------------------------------------
 
     public recalculateLastFilename(last: string, filenames: string[]) {
+        const ext = ".7z";
         return filenames
-            .map(filename => filename.endsWith(".7z") ? filename.substring(0, filename.length - 3) : filename)
+            .map(filename => filename.endsWith(ext) ? filename.substring(0, filename.length - ext.length) : filename)
             .filter(basename => this.isEnumeratedName(basename))
             .reduce((a, b) => this.getLastFilename(a, b), this.isEnumeratedName(last) ? last : "");
     }

diff --git a/src/version.ts b/src/version.ts
@@ -1,3 +1,3 @@
-const APPLICATION_VERSION = "1.0.1"
+const APPLICATION_VERSION = "1.0.2"
 const COPYRIGHT_OWNER = "David Hofmann";
 const COPYRIGHT_YEARS = "2022";