Fix: Compressed files with unsupported chars in Windows are not correct displayed

Author: ollm

CHANGELOG.md

@@ -43,6 +43,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - Turn page forward in manga mode (Only on non-arrow keys) [`bdbc0dc`](https://github.com/ollm/OpenComic/commit/bdbc0dc31ab37bdfcef570bf8f2130e39c08861e)
 - Check if the file is written to disk when extracting using 7zip [`66d4897`](https://github.com/ollm/OpenComic/commit/66d48977b4ef33b320676d39656d48ea41aff653)
 - Wrong size detection for animated AVIF images [`b741e52`](https://github.com/ollm/OpenComic/commit/b741e52c1fffac842a782fc45536eada123edeba)
+- Compressed files with unsupported chars in Windows are not correct displayed
 
 ## [v1.4.1](https://github.com/ollm/OpenComic/releases/tag/v1.4.1) (08-02-2025)
 

scripts/file-manager.js

@@ -221,7 +221,7 @@ var file = function(path, _config = false) {
 					if(json.error && !this.config.fromThumbnailsGeneration && !this.config.subtask)
 						dom.compressedError({message: json.error}, false, sha1(this.path));
 
-					setFileSizes(path, json.files);
+					setFileData(path, json.files);
 
 					return json.files;
 				}
@@ -246,7 +246,7 @@ var file = function(path, _config = false) {
 		if(!json || json.mtime != mtime)
 			cache.writeJson(compressed.cacheFile, {mtime: mtime, files: files, metadata: metadata});
 
-		setFileSizes(path, files);
+		setFileData(path, files);
 
 		return files;
 
@@ -1514,18 +1514,20 @@ var fileCompressed = function(path, _realPath = false, forceType = false, prefix
 
 	this._filesToMultidimension = function(files, dimensions, from = false) {
 
-		let _files = [];
+		const _files = [];
 
 		for(let key in dimensions)
 		{
-			let value = dimensions[key];
+			const value = dimensions[key];
 
 			if(typeof value === 'number')
 			{
-				let file = files[value];
+				const file = files[value];
 
-				let data = {
+				const data = {
 					name: key,
+					fixedName: file.fixedName || key,
+					originalName: file.originalName || file.fixedName || key,
 					path: file.path,
 					folder: file.folder ? true : false,
 					fileSize: file.fileSize || 0,
@@ -1539,7 +1541,7 @@ var fileCompressed = function(path, _realPath = false, forceType = false, prefix
 			}
 			else
 			{
-				let _name = from ? p.join(from, key) : key;
+				const _name = from ? p.join(from, key) : key;
 
 				_files.push({
 					name: key,
@@ -1700,6 +1702,25 @@ var fileCompressed = function(path, _realPath = false, forceType = false, prefix
 
 	}
 
+	this.fixUnsupportedCharsInWindows = function(path) {
+
+		if(process.platform !== 'win32')
+			return path;
+
+		// Replace dots and spaces at the end of the filename
+		path = path.replace(/([\. ]+)([\\\/]|$)/g, function(match, unsupported, separator) {
+
+			return '_'.repeat(unsupported.length)+separator;
+
+		});
+
+		// Replace unsupported characters
+		path = path.replace(/[<>:|?*"]/g, '_');
+
+		return path;
+
+	}
+
 	// 7z
 	this._7z = false;
 
@@ -1737,9 +1758,14 @@ var fileCompressed = function(path, _realPath = false, forceType = false, prefix
 
 				if(data.file)
 				{
-					let name = _this.removeTmp(p.normalize(data.file));
+					if(/^D/.test(data.attributes) && !data.size) // Ignore directories
+						return;
 
-					files.push({name: name, path: p.join(_this.path, name), fileSize: data.size});
+					const originalName = _this.removeTmp(p.normalize(data.file));
+					const name = _this.fixUnsupportedCharsInWindows(originalName);
+					const same = originalName === name ? true : false;
+
+					files.push({name: name, fixedName: (!same ? name : ''), originalName: (!same ? originalName : ''), path: p.join(_this.path, name), fileSize: data.size});
 					_this.setFileStatus(name, {extracted: false});
 
 					readSome = true;
@@ -1775,8 +1801,26 @@ var fileCompressed = function(path, _realPath = false, forceType = false, prefix
 
 		let _this = this;
 
-		const onlyLen = this.config._only ? this.config._only.length : false;
-		const tasks = this.stackOnlyInTasks(this.config._only || false, 100);
+		const only = [];
+		const extractName = {};
+
+		let onlyLen = this.config._only ? this.config._only.length : false;
+
+		// Use the original file name and not the extracted one, which may be different on Windows due to incompatibility with certain characters (fixUnsupportedCharsInWindows)
+		for(let i = 0; i < onlyLen; i++)
+		{
+			const file = this.config._only[i];
+			const originalName = fileOriginalName.get(file) || file;
+
+			if(!extractName[originalName])
+			{
+				extractName[originalName] = file;
+				only.push(originalName);
+			}
+		}
+
+		onlyLen = only.lenght;
+		const tasks = this.stackOnlyInTasks(only || false, 100);
 
 		let result = false;
 
@@ -1800,7 +1844,9 @@ var fileCompressed = function(path, _realPath = false, forceType = false, prefix
 					{
 						_this.setProgress(_this.progressIndex++ / onlyLen);
 
-						const name = _this.removeTmp(p.normalize(data.file));
+						let name = _this.removeTmp(p.normalize(data.file));
+						name = extractName[name] || name;
+
 						const path = p.join(_this.path, name);
 						const realPath = p.join(_this.tmp, name);
 
@@ -2305,29 +2351,38 @@ var fileCompressed = function(path, _realPath = false, forceType = false, prefix
 
 }
 
+var fileDataInMap = new Set();
 var fileSizes = new Map();
-var fileSizesInMap = new Set();
+var fileOriginalName = new Map();
 
-function _setFileSizes(files)
+function _setFileData(files)
 {
 	for(let i = 0, len = files.length; i < len; i++)
 	{
 		const file = files[i];
 
 		if(file.files)
-			_setFileSizes(file.files);
-		else if(file.fileSize)
-			fileSizes.set(file.path, file.fileSize);
+		{
+			_setFileData(file.files);
+		}
+		else
+		{
+			if(file.fileSize)
+				fileSizes.set(file.path, file.fileSize);
+
+			if(file.fixedName && file.originalName)
+				fileOriginalName.set(file.fixedName, file.originalName);
+		}
 	}
 }
 
-function setFileSizes(path, files)
+function setFileData(path, files)
 {
-	if(fileSizesInMap.has(path))
+	if(fileDataInMap.has(path))
 		return;
 
-	fileSizesInMap.add(path);
-	_setFileSizes(files);
+	fileDataInMap.add(path);
+	_setFileData(files);
 }
 
 var extractingPromises = {};

scripts/migration.js

@@ -62,7 +62,7 @@ function clearPdfAndEpubCache()
 	{
 		const file = files[i];
 
-		if(/\.json$/.test(file) || /\.json\.zstd$/.test(file))
+		if(/^compressed-files-/.test(file))
 		{
 			const json = cache.readJson(file.replace(/\.zstd$/, ''));
 			const first = json.files[0] ?? false;
@@ -255,6 +255,57 @@ function migratePasswordsAndTokensToSafeStorage(data)
 	return data;
 }
 
+function hasUnsupportedCharsInWindows(files)
+{
+	for(let i = 0, len = files.length; i < len; i++)
+	{
+		const file = files[i];
+		const path = file.path.replace(/^[a-z0-9]+\:/i, '');
+
+		// Dots and spaces at the end of the filename
+		if(/([\. ]+)([\\\/]|$)/.test(path))
+			return true;
+
+		// Unsupported characters
+		if(/[<>:|?*"]/.test(path))
+			return true;
+
+		if(file.files && hasUnsupportedCharsInWindows(file.files))
+			return true;
+	}
+
+	return false;
+}
+
+function migrateCompressedFilesWithUnsupportedCharsInWindows(data)
+{
+	if(process.platform !== 'win32')
+		return data;
+
+	console.time('Migration: compressedFilesWithUnsupportedCharsInWindows');
+
+	const files = fs.readdirSync(cache.folder);
+
+	for(let i = 0, len = files.length; i < len; i++)
+	{
+		const file = files[i];
+
+		if(/^compressed-files-/.test(file))
+		{
+			const json = cache.readJson(file.replace(/\.zstd$/, ''));
+
+			if(hasUnsupportedCharsInWindows(json.files))
+				fs.unlinkSync(p.join(cache.folder, file));
+		}
+	}
+
+	cache.flushJsonMemory();
+
+	console.timeEnd('Migration: compressedFilesWithUnsupportedCharsInWindows');
+
+	return data;
+}
+
 function start(data)
 {
 	let changes = data.config.changes;
@@ -285,6 +336,9 @@ function start(data)
 	if(changes < 110) // Use safeStorage for passwords and tokens
 		data = migratePasswordsAndTokensToSafeStorage(data);
 
+	if(changes < 113) // Fix compressed files with unsupported characters in Windows
+		data = migrateCompressedFilesWithUnsupportedCharsInWindows(data);
+
 	data = opds.addNewDefaultCatalogs(data, changes);
 
 	return data;

scripts/storage.js

@@ -1,6 +1,6 @@
 const safe = require(p.join(appDir, 'scripts/storage/safe.js'));
 
-const changes = 112; // Update this if readingPagesConfig is updated
+const changes = 113; // Update this if readingPagesConfig is updated
 
 const readingPagesConfig = {
 	readingConfigName: '',

scripts/threads.js

@@ -2,6 +2,7 @@ var threads = false;
 var threadsList = {};
 var queue = {default: []};
 var queueIsStop = {default: false};
+var stats = {};
 var onEnd = {};
 
 async function job(key = 'default', options = {}, callback = false)
@@ -40,6 +41,7 @@ async function job(key = 'default', options = {}, callback = false)
 function addToQueue(key, options, callback, _arguments, promise)
 {
 	if(!queue[key]) queue[key] = [];
+	if(!stats[key]) stats[key] = {done: 0};
 
 	if(options.priorize)
 	{
@@ -124,6 +126,8 @@ async function startJob(thread)
 		thread.currentJob = false;
 		thread.busy = false;
 
+		stats[thread.key].done++;
+
 		processJob(thread.key, thread.thread);
 	}
 	catch(error)
@@ -183,10 +187,56 @@ function end(key, callback)
 	onEnd[key] = callback;
 }
 
+function getStats(key = false)
+{
+	const _stats = {};
+
+	for(let key in queue)
+	{
+		const list = Object.values(threadsList[key] ?? {});
+
+		_stats[key] = {
+			key: key,
+			done: stats[key]?.done || 0,
+			busy: list.filter(thread => thread.busy).length,
+			queue: queue[key]?.length,
+			threads: (!list.length || list.length === threads) ? list.length : list.length - 1,
+		};
+	}
+
+	return key ? _stats[key] : _stats;
+}
+
+function sumStats()
+{
+	const sum = {
+		done: 0,
+		busy: 0,
+		queue: 0,
+		threads: 0,
+	};
+
+	const stats = getStats();
+
+	for(let key in stats)
+	{
+		const stat = stats[key];
+
+		sum.done += stat.done;
+		sum.busy += stat.busy;
+		sum.queue += stat.queue;
+		sum.threads += stat.threads;
+	}
+
+	return sum;
+}
+
 module.exports = {
 	job: job,
 	stop: stop,
 	resume: resume,
 	clean: clean,
 	end: end,
+	stats: getStats,
+	sumStats: sumStats,
 }