tykayn/rangement
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

set debug log, add config option in name reconstruction, clean spaces and underscores

Browse Source
This commit is contained in:
Tykayn 2023-07-04 15:56:15 +02:00 committed by tykayn
parent 62d14c07b4
commit e1f819d8e3
7 changed files with 111 additions and 96 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -38,7 +38,7 @@ mais ce n'est pas encore prêt à être utilisé en production.
# Roadmap # Roadmap
* Internationalisation of console texts * Internationalisation of console texts
* Proper testing * Proper testing
* Template configuration for auto dispatching of files after rename
* Handle a configuration file * Handle a configuration file
- * create config file if needed - * create config file if needed
* batch rename like the python pip script "guessfilename" * batch rename like the python pip script "guessfilename"

86
configs.mjs
View File

@ -1,46 +1,48 @@
class config_rangement {
class config_rangement{ log_level = 'info' // 'debug' | 'warn' |'info'
log_level ='debug' // 'debug' | 'warn' |'info' version = '1.0.0'
version = '1.0.0' tagSeparator = '1.0.0'
tagSeparator = '1.0.0' tagSectionSeparator = '1.0.0'
tagSectionSeparator = '1.0.0' keepFreeText = true
keepFreeText= true keepTags = true
keepTags= true replaceUnderscoreWithSpaces = true
enableTestsLocally= false renameFolders = false
reportStatistics= false enableTestsLocally = false
base_archive_folder= '/home/poule/encrypted/stockage-syncable/' reportStatistics = false
photos_sub_folder= 'photos' base_archive_folder = '/home/poule/encrypted/stockage-syncable/'
photos_sorting_base_sub_folder= 'photos/a_dispatcher' photos_sub_folder = this.base_archive_folder + 'photos/'
bazar_sub_folder= 'BAZAR' photos_sorting_base_sub_folder = this.base_archive_folder + 'photos/a_dispatcher/'
panoramax_captures_folder= 'photos/imagerie kartaview carto tel/open camera' bazar_sub_folder = this.base_archive_folder + 'BAZAR/'
templates = { panoramax_captures_folder = 'photos/imagerie kartaview carto tel/open camera/'
// example FyB8cZnWIAc21rw.jpg templates = {
'downloaded_pic': { // example FyB8cZnWIAc21rw.jpg
'pattern' : /^\-\w{15}\.jpg/, 'downloaded_pic': {
'auto_sort_folder' : this.bazar_sub_folder 'pattern': /^\-\w{15}\.jpg/,
}, 'auto_sort_folder': this.bazar_sub_folder
// example -4900281569878475578_1109.jpg },
'telegram_pic': { // example -4900281569878475578_1109.jpg
'pattern' : /^\-\d{19}_\d{4}/, 'telegram_pic': {
'auto_sort_folder' : '' 'pattern': /^\-\d{19}_\d{4}/,
}, 'auto_sort_folder': this.bazar_sub_folder
// example IMG_20230617_092120_3.jpg },
'open_camera_default': { // example IMG_20230617_092120_3.jpg
'pattern' : /^IMG_\d{8}/i, 'open_camera_default': {
'auto_sort_folder' : this.panoramax_captures_folder 'pattern': /^IMG_\d{8}/i,
}, 'auto_sort_folder': this.panoramax_captures_folder
// example IMG_OC_20230617_092120_3.jpg },
'open_camera_custom': { // example IMG_OC_20230617_092120_3.jpg
'pattern' : /^IMG_OC_\d{8}/i, 'open_camera_custom': {
'auto_sort_folder' : this.panoramax_captures_folder 'pattern': /^IMG_OC_\d{8}/i,
}, 'auto_sort_folder': this.panoramax_captures_folder
// example "Screenshot 2023-06-15 at 15-26-04 Instance Panoramax OSM-FR.png" },
'screenshot': { // example "Screenshot 2023-06-15 at 15-26-04 Instance Panoramax OSM-FR.png"
'pattern' : /^Screenshot/i, 'screenshot': {
'auto_sort_folder': 'photos/captures écran screenshots' 'pattern': /^Screenshot/i,
} , 'auto_sort_folder': 'photos/captures écran screenshots'
} },
}
} }
const rangement_instance = new config_rangement(); const rangement_instance = new config_rangement();
export const tagSeparator = rangement_instance.tagSeparator export const tagSeparator = rangement_instance.tagSeparator

52
finder.mjs
View File

@ -28,7 +28,7 @@ export default class finder {
static findFormattedDate (filepath) { static findFormattedDate (filepath) {
let match = filepath.match(/\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}/ig) let match = filepath.match(/\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}/ig)
// log.debug('match findFormattedDate', match) log.debug(' finder - match findFormattedDate', match)
let result = '' let result = ''
if (match && match[0]) { if (match && match[0]) {
result = match[0] result = match[0]
@ -51,7 +51,7 @@ export default class finder {
let boom = fileName.split(tagSectionSeparator) let boom = fileName.split(tagSectionSeparator)
if (boom.length) { if (boom.length) {
let freeTextPart = boom[0].trim() let freeTextPart = boom[0].trim()
log.debug('freeTextPart', freeTextPart) log.debug(' finder - freeTextPart', freeTextPart)
return freeTextPart return freeTextPart
} }
return fileName.trim() return fileName.trim()
@ -70,24 +70,24 @@ export default class finder {
if (extensionFile) { if (extensionFile) {
extensionFile = extensionFile[0] extensionFile = extensionFile[0]
} else { } else {
log.debug('no extensionFile', extensionFile, inputString) log.debug(' finder - no extensionFile', extensionFile, inputString)
extensionFile = '' extensionFile = ''
} }
inputString = inputString.replace(extensionFile, '') inputString = inputString.replace(extensionFile, '')
// log.debug('extensionFile', extensionFile) log.debug(' finder - extensionFile', extensionFile)
if (inputString.includes(tagSectionSeparator)) { if (inputString.includes(tagSectionSeparator)) {
// log.debug('inputString', inputString) log.debug(' finder - inputString', inputString)
if (inputString.length) { if (inputString.length) {
let boom = inputString.split(tagSectionSeparator) let boom = inputString.split(tagSectionSeparator)
// log.debug('boom', boom) // log.debug(' finder - boom', boom)
if (boom.length) { if (boom.length) {
let fileSectionsName = boom.splice(tagSeparator) let fileSectionsName = boom.splice(tagSeparator)
listOfTags = [...fileSectionsName[1].trim().split(tagSeparator)] listOfTags = [...fileSectionsName[1].trim().split(tagSeparator)]
// log.debug('listOfTags', listOfTags) log.debug(' finder - listOfTags', listOfTags)
} else { } else {
log.debug('no boom', boom) log.debug(' finder - no boom', boom)
} }
} }
} }
@ -108,15 +108,15 @@ export default class finder {
static searchAndRenameScreenshots (fileName) { static searchAndRenameScreenshots (fileName) {
if (finder.findScreenshot(fileName)) { if (finder.findScreenshot(fileName)) {
let tags = this.findTagSectionInString(fileName) let tags = this.findTagSectionInString(fileName)
log.debug('tags', tags) log.debug(' finder - tags', tags)
if (!tags.includes('screenshot')) { if (!tags.includes('screenshot')) {
fileName = this.addTagInFileName('screenshot', fileName) fileName = this.addTagInFileName('screenshot', fileName)
fileName = this.searchAndReplaceInFileName('Screenshot', '', fileName) fileName = this.searchAndReplaceInFileName('Screenshot', '', fileName)
log.debug('screenShotMockFileName:', fileName) log.debug(' finder - screenShotMockFileName:', fileName)
return this.cleanSpaces(fileName) return this.cleanSpaces(fileName)
} }
log.debug('is a screenshot, remove screenshot in name, and add tag screenshot') log.debug(' finder - is a screenshot, remove screenshot in name, and add tag screenshot')
} else { } else {
return null return null
} }
@ -166,17 +166,17 @@ export default class finder {
let moments = [] let moments = []
// log.debug('exif data : ', exifData) // Do something with your data! log.debug(' finder - exif data : ', exifData) // Do something with your data!
if (exifData.DateTimeOriginal) { if (exifData.DateTimeOriginal) {
// log.debug('image créée le : DateTimeOriginal : ', exifData.DateTimeOriginal) // Do something with your data! log.debug(' finder - image créée le : DateTimeOriginal : ', exifData.DateTimeOriginal) // Do something with your data!
moments.push(exifData.DateTimeOriginal) moments.push(exifData.DateTimeOriginal)
} }
if (exifData.ModificationDateTime) { if (exifData.ModificationDateTime) {
// log.debug('image créée le : ModificationDateTime : ', exifData.ModificationDateTime) // Do something with your data! log.debug(' finder - image créée le : ModificationDateTime : ', exifData.ModificationDateTime) // Do something with your data!
moments.push(exifData.ModificationDateTime) moments.push(exifData.ModificationDateTime)
} }
if (exifData.ModifyDate) { if (exifData.ModifyDate) {
// log.debug('image créée le : ModifyDate : ', exifData.ModifyDate) // Do something with your data! log.debug(' finder - image créée le : ModifyDate : ', exifData.ModifyDate) // Do something with your data!
moments.push(exifData.ModifyDate) moments.push(exifData.ModifyDate)
} }
if (exifData.FileAccessDateTime) { if (exifData.FileAccessDateTime) {
@ -186,11 +186,11 @@ export default class finder {
moments.push(exifData.FileInodeChangeDateTime) moments.push(exifData.FileInodeChangeDateTime)
} }
if (exifData.FileModificationDateTime) { if (exifData.FileModificationDateTime) {
// log.debug('image créée le : FileModificationDateTime : ', exifData.FileModificationDateTime) // Do something with your data! log.debug(' finder - image créée le : FileModificationDateTime : ', exifData.FileModificationDateTime) // Do something with your data!
moments.push(exifData.FileModificationDateTime) moments.push(exifData.FileModificationDateTime)
} }
if (exifData.CreateDate) { if (exifData.CreateDate) {
// log.debug('image créée le : CreateDate : ', exifData.CreateDate) // Do something with your data! log.debug(' finder - image créée le : CreateDate : ', exifData.CreateDate) // Do something with your data!
moments.push(exifData.CreateDate) moments.push(exifData.CreateDate)
} }
@ -200,27 +200,31 @@ export default class finder {
}) })
let minDate = moment.min(moments) let minDate = moment.min(moments)
// log.debug('minDate :::::::::', minDate) log.debug(' finder - minDate :::::::::', minDate)
log.debug('minDate :::::::::', minDate.format('yyyy-MM-DDTHH:mm:ss')) log.debug(' finder - minDate :::::::::', minDate.format('yyyy-MM-DDTHH:mm:ss'))
return minDate.format('yyyy-MM-DDTHH:mm:ss') return minDate.format('yyyy-MM-DDTHH:mm:ss')
} else { } else {
log.debug('pas de exif data') log.debug(' finder - pas de exif data')
return '' return ''
} }
} }
static findTemplateInFileName(fileName){
// test all templates from configuration
}
/** /**
* examine plusieurs propriétés exif de date et retourne la plus ancienne * examine plusieurs propriétés exif de date et retourne la plus ancienne
* @param filepath * @param filepath
*/ */
static async findExifCreationDate (filepath) { static async findExifCreationDate (filepath) {
log.debug('filepath', filepath) log.debug(' finder - filepath', filepath)
let dateAlreadyInFileName = finder.findFormattedDate(filepath) let dateAlreadyInFileName = finder.findFormattedDate(filepath)
if (dateAlreadyInFileName) { if (dateAlreadyInFileName) {
log.debug('------ dateAlreadyInFileName', dateAlreadyInFileName) log.debug(' finder - ------ dateAlreadyInFileName', dateAlreadyInFileName)
} }
return await exifr.parse(filepath) return await exifr.parse(filepath)
@ -232,8 +236,8 @@ export default class finder {
let fileName = folders.pop() let fileName = folders.pop()
folders = filePath.replace(fileName, '') folders = filePath.replace(fileName, '')
log.debug('\n - folders', folders) log.debug(' finder - \n - folders', folders)
log.debug(' - fileName', fileName, '\n') log.debug(' finder - - fileName', fileName, '\n')
return [folders, fileName] return [folders, fileName]
} }

67
index.mjs
View File

@ -35,16 +35,16 @@ function parseArguments() {
function addOriginalFileNameIfMissing(originalFileName, fileMixedNewName) { function addOriginalFileNameIfMissing(originalFileName, fileMixedNewName) {
const ep = new exiftool.ExiftoolProcess() // const ep = new exiftool.ExiftoolProcess()
//
ep // ep
.open(fileMixedNewName) // .open(fileMixedNewName)
.then(() => ep.writeMetadata(fileMixedNewName, { // .then(() => ep.writeMetadata(fileMixedNewName, {
'OriginalFileName+': originalFileName, // 'OriginalFileName+': originalFileName,
})) // }))
.then(console.log, console.error) // .then(console.log, console.error)
.then(() => ep.close()) // .then(() => ep.close())
.catch(console.error) // .catch(console.error)
} }
function renameFile(originalFileName, fileMixedNewName) { function renameFile(originalFileName, fileMixedNewName) {
@ -54,7 +54,7 @@ function renameFile(originalFileName, fileMixedNewName) {
log.info('rename ERROR: ' + err) log.info('rename ERROR: ' + err)
} else { } else {
addOriginalFileNameIfMissing(originalFileName, fileMixedNewName) addOriginalFileNameIfMissing(originalFileName, fileMixedNewName)
rangement_instance.statistics['filesModified']++ // rangement_instance.statistics['filesModified']++
} }
}) })
} }
@ -72,16 +72,29 @@ function prependFileName(fileProperties, newText) {
function makeFileNameFromProperties(fileProperties) { function makeFileNameFromProperties(fileProperties) {
let tagPlace = '' let tagPlace = ''
if (fileProperties.tags.length) { if (fileProperties.tags.length && rangement_instance.keepTags) {
tagPlace = ' ' + rangement_instance.tagSectionSeparator + ' ' tagPlace = ' ' + rangement_instance.tagSectionSeparator + ' '+ fileProperties.tags.join(rangement_instance.tagSeparator)
} }
return '' + fileProperties.dateStampExif + ' ' + fileProperties.freeText + tagPlace + fileProperties.tags.join(tagSeparator) + fileProperties.extension let newName = ''
+ fileProperties.dateStampExif
+ ' '
+ (rangement_instance.keepFreeText? fileProperties.freeText : '')
+ tagPlace
+ fileProperties.extension;
if(rangement_instance.replaceUnderscoreWithSpaces){
newName = newName.replace('_', ' ')
}
newName = newName.replace(' ', '')
return newName
} }
function shouldWeChangeName(structureForFile) { function shouldWeChangeName(structureForFile) {
log.info(' ______ allez hop fini la recherche on fait un nouveau nom') log.info(' ______ shouldWeChangeName ', structureForFile.fileNameOriginal)
log.info('structureForFile', structureForFile)
let newName = makeFileNameFromProperties(structureForFile) let newName = makeFileNameFromProperties(structureForFile)
log.debug('newName', newName)
if (structureForFile.fileNameOriginal !== newName) { if (structureForFile.fileNameOriginal !== newName) {
log.info('\n ancien nom :', structureForFile.fileNameOriginal) log.info('\n ancien nom :', structureForFile.fileNameOriginal)
@ -95,7 +108,6 @@ function shouldWeChangeName(structureForFile) {
} else { } else {
log.info(' rien à changer') log.info(' rien à changer')
} }
} }
/** /**
@ -104,6 +116,7 @@ function shouldWeChangeName(structureForFile) {
*/ */
function guessFileNameOnOnefile(fullPath) { function guessFileNameOnOnefile(fullPath) {
log.info('go guess file name on file: ', fullPath )
fs.stat(fullPath, (err, stats) => { fs.stat(fullPath, (err, stats) => {
if (err) { if (err) {
@ -116,22 +129,20 @@ function guessFileNameOnOnefile(fullPath) {
// examiner les infos exif de chaque fichier pour proposer un nouveau nom // examiner les infos exif de chaque fichier pour proposer un nouveau nom
if (!structureForFile.dateStampInFileNameOriginal) { if (!structureForFile.dateStampInFileNameOriginal) {
log.debug(' le nom de fichier ne contient pas de date formatée au début') log.info(' le nom de fichier "'+structureForFile.freeText +'" ne contient pas de date formatée au début')
finder.findExifCreationDate(structureForFile.fullPath) finder.findExifCreationDate(structureForFile.fullPath)
.then(data => { .then(data => {
log.debug(' ... chercher la date de création') log.info(' ... chercher la date de création : "'+structureForFile.freeText +'"')
let foundDate = finder.findEarliestDateInExifData(data) let foundDate = finder.findEarliestDateInExifData(data)
log.info(' =>>>>>>> foundDate : ', foundDate) log.info(' =>>>>>>> foundDate : ', foundDate)
if (foundDate) { if (foundDate) {
structureForFile.dateStampExif = foundDate structureForFile.dateStampExif = foundDate
shouldWeChangeName(structureForFile)
} else { } else {
log.info('pas de date trouvée dans le nom') log.info('pas de date trouvée dans le nom')
} }
shouldWeChangeName(structureForFile)
} }
, ,
(error) => { (error) => {
@ -170,29 +181,27 @@ function guessFileNameOnAllFilesFromArguments() {
function readSubdirectories(baseDir) { function readSubdirectories(baseDir) {
const newGlob = baseDir; const newGlob = baseDir;
let fileList = [];
fs.readdir(baseDir, (err, files) => { fs.readdir(baseDir, (err, files) => {
if (err) throw err; if (err) throw err;
console.log('files', files) console.log('readSubdirectories - files', files)
files.forEach((subDirOrFile) => { files.forEach((subDirOrFile) => {
const newFullPath = path.resolve(baseDir, subDirOrFile); const newFullPath = cwd +'/'+ subDirOrFile;
if (fs.existsSync(newFullPath)) { if (fs.existsSync(newFullPath)) {
const s = fs.statSync(newFullPath); const s = fs.statSync(newFullPath);
if (s.isFile()) { if (s.isFile()) {
fileList.push(cwd+'/'+subDirOrFile) expandedFileList.push(cwd+'/'+subDirOrFile)
} }
} }
}); });
return fileList
}); });
return fileList
} }
function isFolderOrFile(fileName) { function isFolderOrFile(fileName) {
const stat = fs.statSync(cwd + '/' + fileName); // const stat = fs.statSync(cwd + '/' + fileName);
const stat = fs.statSync( fileName);
if (stat.isDirectory()) { if (stat.isDirectory()) {
let fileList = readSubdirectories(fileName); let fileList = readSubdirectories(fileName);

0
testFiles/2020-06-21T14:27:19 2020-0 image.jpg → testFiles/2020-06-21T14:27:19 image.jpg
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 1.7 MiB

After

Width:  |  Height:  |  Size: 1.7 MiB

0
testFiles/meme/2023-06-14T13.29.22 FyB8cZnWIAc21rw -- meme.jpg → testFiles/meme/ FyB8cZnWIAc21rw -- meme.jpg
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 21 KiB

After

Width:  |  Height:  |  Size: 21 KiB

0
testFiles/meme/2023-06-26T18.53.59 FzjSx2YWcAEqsde -- meme.jpg → testFiles/meme/ FzjSx2YWcAEqsde -- meme.jpg
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 55 KiB

After

Width:  |  Height:  |  Size: 55 KiB