New: Custom name in image saving function

Author: ollm

CHANGELOG.md

@@ -12,10 +12,15 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [v1.3.1](https://github.com/ollm/OpenComic/releases/tag/v1.3.1) (05-10-2024)
 
+##### 🚀 New Features
+
+- Custom name in image saving function
+
 ##### 🐛 Bug Fixes
 
 - Dependency file-type not working [`7730e46`](https://github.com/ollm/OpenComic/commit/7730e46c8eb9e43196e50bd557f03132968eb534)
 - Open file location not working in some cases [`a4bc25b`](https://github.com/ollm/OpenComic/commit/a4bc25b3005c097a7852a96c8c41fd866b28ed1c)
+- Save image not saving the correct page in manga mode [`b14a26e`](https://github.com/ollm/OpenComic/commit/b14a26eacdc77d37cdeb578fc203438058c7c5e2)
 
 ## [v1.3.0](https://github.com/ollm/OpenComic/releases/tag/v1.3.0) (04-10-2024)
 

scripts/reading/context-menu.js

@@ -77,6 +77,33 @@ function saveImage()
 	saveAllImages(currentIndex - 1);
 }
 
+function generateFileName(path, page, leadingZeros, fileName)
+{
+	// Parent folder name
+	let parentFolderName = p.dirname(p.dirname(path));
+	let ext1 = p.extname(parentFolderName);
+	parentFolderName = p.basename(parentFolderName, (ext1 && ext1.length < 6 ? ext1 : ''));
+
+	// Current file/folder name
+	let folderName = p.dirname(path);
+	let ext2 = p.extname(folderName);
+	folderName = p.basename(folderName, (ext2 && ext2.length < 6 ? ext2 : ''));
+
+	const extension = p.extname(path);
+	const imageName = p.basename(path, extension);
+
+	fileName = fileName.replace(/\[parentFolder(?:Name)?\]/, parentFolderName);
+	fileName = fileName.replace(/\[folder(?:Name)?\]/, folderName);
+	fileName = fileName.replace(/\[image(?:Name)?\]/, imageName);
+	fileName = fileName.replace(/\[page\]/, String(page).padStart(leadingZeros, '0'));
+	fileName = fileName.replace(/\[pageInt\]/, page);
+
+	let ext3 = p.extname(fileName);
+	if(!ext3 || ext3.length >= 6) fileName += extension;
+
+	return fileName;
+}
+
 function saveAllImages(index = false)
 {
 	const images = reading.images();
@@ -88,53 +115,76 @@ function saveAllImages(index = false)
 			index = (reading.indexNum() - index) - 1;
 	}
 
-	electronRemote.dialog.showOpenDialog({properties: ['openDirectory', 'createDirectory'], buttonLabel: language.buttons.save}).then(async function(files) {
+	const saveDialog = macosMAS ? saveDialogDirectory : saveDialogFile;
 
-		if(files.filePaths && files.filePaths[0] && fs.statSync(files.filePaths[0]).isDirectory())
+	saveDialog(async function(saveTo, fileName){
+
+		const toSave = [];
+		let highestPage = 0;
+
+		for(let key in images)
 		{
-			const saveTo = files.filePaths[0];
-			const toSave = [];
+			const path = images[key].path;
 
-			for(let key in images)
-			{
-				const path = images[key].path;
+			if(index === false || index == imagesData[key].position)
+				toSave.push({path: path, page: key});
 
-				if(index === false || index == imagesData[key].position)
-					toSave.push({path: path});
-			}
+			if(+key > highestPage)
+				highestPage = +key;
+		}
 
-			let first = '';
+		const leadingZeros = String(highestPage).length;
+		let first = '';
+
+		if(toSave.length)
+		{
+			let file = fileManager.file(p.dirname(toSave[0].path));
+			await file.makeAvailable(toSave);
+			file.destroy();
 
-			if(toSave.length)
+			for(let i = 0, len = toSave.length; i < len; i++)
 			{
-				let file = fileManager.file(p.dirname(toSave[0].path));
-				await file.makeAvailable(toSave);
-				file.destroy();
+				const image = toSave[i];
+				const realPath = fileManager.realPath(image.path);
+				const saveImageTo = p.join(saveTo, generateFileName(image.path, image.page, leadingZeros, fileName));
+				if(first === '') first = saveImageTo;
 
+				if(!fs.existsSync(saveImageTo))
+					fs.copyFileSync(realPath, saveImageTo);
+			}
+		}
 
-				for(let i = 0, len = toSave.length; i < len; i++)
+		events.snackbar({
+			key: 'saveAllImages',
+			text: language.global.contextMenu.saveImagesMessage,
+			duration: 6,
+			buttons: [
 				{
-					const realPath = fileManager.realPath(toSave[i].path);
-					const saveImageTo = p.join(saveTo, p.basename(realPath));
-					if(first === '') first = p.basename(realPath);
+					text: language.global.open,
+					function: 'electron.shell.showItemInFolder(\''+escapeQuotes(escapeBackSlash(first), 'simples')+'\');',
+				},
+			],
+		});
 
-					if(!fs.existsSync(saveImageTo))
-						fs.copyFileSync(realPath, saveImageTo);
-				}
-			}
+	});
+}
 
-			events.snackbar({
-				key: 'saveAllImages',
-				text: language.global.contextMenu.saveImagesMessage,
-				duration: 6,
-				buttons: [
-					{
-						text: language.global.open,
-						function: 'electron.shell.showItemInFolder(\''+escapeQuotes(escapeBackSlash(p.join(saveTo, first)), 'simples')+'\');',
-					},
-				],
-			});
-		}
+function saveDialogFile(callback)
+{
+	electronRemote.dialog.showSaveDialog({properties: ['openDirectory', 'createDirectory'], buttonLabel: language.buttons.save, defaultPath: '[parentFolder] - [folder] - [image] - [page]'}).then(function(result) {
+
+		if(!result.canceled && result.filePath)
+			callback(p.dirname(result.filePath), p.basename(result.filePath));
+
+	});
+}
+
+function saveDialogDirectory(callback)
+{
+	electronRemote.dialog.showOpenDialog({properties: ['openDirectory', 'createDirectory'], buttonLabel: language.buttons.save}).then(function(files) {
+
+		if(files.filePaths && files.filePaths[0] && fs.statSync(files.filePaths[0]).isDirectory())
+			callback(files.filePaths[0], '[folder] - [image] - [page]');
 
 	});
 }