mediac 0.7.0 → 1.3.0

package/cmd/cmd_audiotag.js

@@ -0,0 +1,3 @@
+
+
+// 处理音频文件的metadata，使用taglib，修复TAG，根据文件名修改TAG，根据TAG修改文件名等等

package/cmd/cmd_compress.js

@@ -0,0 +1,360 @@
+/*
+ * File: cmd_compress.js
+ * Created: 2024-03-15 20:34:49
+ * Modified: 2024-03-23 11:51:09
+ * Author: mcxiaoke (github@mcxiaoke.com)
+ * License: Apache License 2.0
+ */
+
+
+import assert from "assert";
+import chalk from 'chalk';
+import * as cliProgress from "cli-progress";
+import dayjs from "dayjs";
+import exif from 'exif-reader';
+import fs from 'fs-extra';
+import inquirer from "inquirer";
+import { cpus } from "os";
+import pMap from 'p-map';
+import path from "path";
+import sharp from "sharp";
+import * as log from '../lib/debug.js';
+import * as mf from '../lib/file.js';
+import * as helper from '../lib/helper.js';
+import { compressImage } from "./cmd_shared.js";
+export { aliases, builder, command, describe, handler };
+
+const command = "compress <input> [output]"
+const aliases = ["cs", "cps"]
+const describe = 'Compress input images to target size'
+
+const QUALITY_DEFAULT = 86;
+const SIZE_DEFAULT = 2048 // in kbytes
+const WIDTH_DEFAULT = 6000;
+
+const builder = function addOptions(ya, helpOrVersionSet) {
+    return ya.option("purge", {
+        alias: "p",
+        type: "boolean",
+        default: false,
+        description: "Purge original image files",
+    })
+        .option("purge-only", {
+            type: "boolean",
+            default: false,
+            description: "Just delete original image files only",
+        })
+        // 是否覆盖已存在的压缩后文件
+        .option("override", {
+            type: "boolean",
+            default: false,
+            description: "Override existing dst files",
+        })
+        // 压缩后文件质量参数  
+        .option("quality", {
+            alias: "q",
+            type: "number",
+            default: QUALITY_DEFAULT,
+            description: "Target image file compress quality",
+        })
+        // 需要处理的最小文件大小
+        .option("size", {
+            alias: "s",
+            type: "number",
+            default: SIZE_DEFAULT,
+            description: "Processing file bigger than this size (unit:k)",
+        })
+        // 需要处理的图片最小尺寸
+        .option("width", {
+            alias: "w",
+            type: "number",
+            default: WIDTH_DEFAULT,
+            description: "Max width of long side of image thumb",
+        })
+        // 确认执行所有系统操作，非测试模式，如删除和重命名和移动操作
+        .option("doit", {
+            alias: "d",
+            type: "boolean",
+            default: false,
+            description: "execute os operations in real mode, not dry run",
+        })
+}
+
+const handler = async function cmdCompress(argv) {
+    const testMode = !argv.doit;
+    const logTag = "cmdCompress";
+    const root = path.resolve(argv.input);
+    assert.strictEqual("string", typeof root, "root must be string");
+    if (!root || !(await fs.pathExists(root))) {
+        log.error(logTag, `Invalid Input: '${root}'`);
+        throw new Error(`Invalid Input: ${root}`);
+    }
+    if (!testMode) {
+        log.fileLog(`Root:${root}`, logTag);
+        log.fileLog(`Argv:${JSON.stringify(argv)}`, logTag);
+    }
+    log.show(logTag, argv);
+    const override = argv.override || false;
+    const quality = argv.quality || QUALITY_DEFAULT;
+    const minFileSize = (argv.size || SIZE_DEFAULT) * 1024;
+    const maxWidth = argv.width || WIDTH_DEFAULT;
+    const purgeOnly = argv.purgeOnly || false;
+    const purgeSource = argv.purge || false;
+    log.show(`${logTag} input:`, root);
+
+    const RE_THUMB = /Z4K|M4K|feature|web|thumb$/i;
+    const walkOpts = {
+        needStats: true,
+        entryFilter: (f) =>
+            f.stats.isFile()
+            && !RE_THUMB.test(f.path)
+            && f.stats.size > minFileSize
+            && helper.isImageFile(f.path)
+    };
+    log.showGreen(logTag, `Walking files ...`);
+    let files = await mf.walk(root, walkOpts);
+    if (!files || files.length == 0) {
+        log.showYellow(logTag, "no files found, abort.");
+        return;
+    }
+    log.show(logTag, `total ${files.length} files found (all)`);
+    if (files.length == 0) {
+        log.showYellow("Nothing to do, abort.");
+        return;
+    }
+    const confirmFiles = await inquirer.prompt([
+        {
+            type: "confirm",
+            name: "yes",
+            default: false,
+            message: chalk.bold.green(`Press y to continue processing...`),
+        },
+    ]);
+    if (!confirmFiles.yes) {
+        log.showYellow("Will do nothing, aborted by user.");
+        return;
+    }
+    const needBar = files.length > 9999 && !log.isVerbose();
+    log.showGreen(logTag, `preparing compress arguments...`);
+    let startMs = Date.now();
+    const addArgsFunc = async (f, i) => {
+        return {
+            ...f,
+            total: files.length,
+            index: i,
+            quality,
+            override,
+            maxWidth,
+        }
+    }
+    files = await Promise.all(files.map(addArgsFunc));
+    files.forEach((t, i) => {
+        t.bar1 = bar1;
+        t.needBar = needBar;
+    });
+    needBar && bar1.start(files.length, 0);
+    let tasks = await pMap(files, preCompress, { concurrency: cpus().length * 4 })
+    needBar && bar1.update(files.length);
+    needBar && bar1.stop();
+    log.info(logTag, "before filter: ", tasks.length);
+    const total = tasks.length;
+    tasks = tasks.filter((t) => t?.dst);
+    const skipped = total - tasks.length;
+    log.info(logTag, "after filter: ", tasks.length);
+    if (skipped > 0) {
+        log.showYellow(logTag, `${skipped} thumbs skipped`)
+    }
+    if (tasks.length == 0) {
+        log.showYellow("Nothing to do, abort.");
+        return;
+    }
+    tasks.forEach((t, i) => {
+        t.total = tasks.length;
+        t.index = i;
+        t.bar1 = null;
+        t.needBar = false;
+    });
+    log.show(logTag, `in ${helper.humanTime(startMs)} tasks:`)
+    tasks.slice(-1).forEach(t => {
+        log.show(helper._omit(t, "stats", "bar1"));
+    })
+    log.info(logTag, argv);
+    testMode && log.showYellow("++++++++++ TEST MODE (DRY RUN) ++++++++++")
+
+    if (purgeOnly) {
+        log.showYellow("+++++ PURGE ONLY (NO COMPRESS) +++++")
+        await purgeSrcFiles(tasks);
+        return;
+    }
+    const answer = await inquirer.prompt([
+        {
+            type: "confirm",
+            name: "yes",
+            default: false,
+            message: chalk.bold.red(
+                `Are you sure to compress ${tasks.length} files? \n[Apply to files bigger than ${minFileSize / 1024}K, target long width is ${maxWidth}] \n${purgeSource ? "(Attention: you choose to delete original file!)" : "(Will keep original file)"}`
+            ),
+        },
+    ]);
+
+    if (!answer.yes) {
+        log.showYellow("Will do nothing, aborted by user.");
+        return;
+    }
+
+    if (testMode) {
+        log.showYellow(logTag, `[DRY RUN], no thumbs generated.`)
+    } else {
+        startMs = Date.now();
+        log.showGreen(logTag, 'startAt', dayjs().format())
+        tasks.forEach(t => t.startMs = startMs);
+        tasks = await pMap(tasks, compressImage, { concurrency: cpus().length / 2 });
+        const okTasks = tasks.filter(t => t?.done);
+        const failedTasks = tasks.filter(t => t?.errorFlag && !t.done);
+        log.showGreen(logTag, `${okTasks.length} files compressed in ${helper.humanTime(startMs)}`)
+        log.showGreen(logTag, 'endAt', dayjs().format(), helper.humanTime(startMs))
+        if (failedTasks.length > 0) {
+            log.showYellow(logTag, `${okTasks.length} tasks are failed`);
+            const failedContent = failedTasks.map(t => t.src).join('\n');
+            const failedLogFile = path.join(root, `mediac_compress_failed_list_${dayjs().format("YYYYMMDDHHmmss")}.txt`);
+            await fs.writeFile(failedLogFile, failedContent);
+            const clickablePath = failedLogFile.split(path.sep).join("/");
+            log.showYellow(logTag, `failed filenames: file:///${clickablePath}`);
+        }
+        if (purgeSource) {
+            await purgeSrcFiles(tasks);
+        }
+    }
+}
+
+
+let compressLastUpdatedAt = 0;
+const bar1 = new cliProgress.SingleBar({ etaBuffer: 300 }, cliProgress.Presets.shades_classic);
+// 文心一言注释 20231206
+// 准备压缩图片的参数，并进行相应的处理  
+async function preCompress(f, options = {}) {
+    const logTag = 'PreCompress'
+    // log.debug("prepareCompressArgs options:", options); // 打印日志，显示选项参数  
+    const maxWidth = options.maxWidth || 6000; // 获取最大宽度限制，默认为6000  
+    let fileSrc = path.resolve(f.path); // 解析源文件路径  
+    const [dir, base, ext] = helper.pathSplit(fileSrc); // 将路径分解为目录、基本名和扩展名  
+    const fileDstTmp = path.join(dir, `_TMP_${base}.jpg`);
+    let fileDst = path.join(dir, `${base}_Z4K.jpg`); // 构建目标文件路径，添加压缩后的文件名后缀  
+    fileSrc = path.resolve(fileSrc); // 解析源文件路径（再次确认）  
+    fileDst = path.resolve(fileDst); // 解析目标文件路径（再次确认）  
+
+    const timeNow = Date.now();
+    if (timeNow - compressLastUpdatedAt > 2 * 1000) {
+        f.needBar && f.bar1.update(f.index);
+        compressLastUpdatedAt = timeNow;
+    }
+
+    if (await fs.pathExists(fileDst)) {
+        // 如果目标文件已存在，则进行相应的处理  
+        log.info(logTag, "exists:", fileDst);
+        return {
+            ...f,
+            width: 0,
+            height: 0,
+            src: fileSrc,
+            dst: fileDst,
+            tmpDst: fileDstTmp,
+            dstExists: true,
+            shouldSkip: true,
+            skipReason: 'DST EXISTS',
+        };
+    }
+    try {
+        const st = await fs.stat(fileSrc);
+        const m = await sharp(fileSrc).metadata();
+        try {
+            if (m?.exif) {
+                const md = exif(m.exif)?.Image;
+                if (md && (md.Copyright?.includes("mediac")
+                    || md.Software?.includes("mediac")
+                    || md.Artist?.includes("mediac"))) {
+                    log.info(logTag, "skip:", fileDst);
+                    return {
+                        ...f,
+                        width: 0,
+                        height: 0,
+                        src: fileSrc,
+                        dst: fileDst,
+                        shouldSkip: true,
+                        skipReason: 'MEDIAC MAKE',
+                    };
+                }
+            }
+        } catch (error) {
+            log.warn(logTag, "exif", error.message, fileSrc);
+            log.fileLog(`ExifErr: <${fileSrc}> ${error.message}`, logTag);
+        }
+
+        const nw =
+            m.width > m.height ? maxWidth : Math.round((maxWidth * m.width) / m.height);
+        const nh = Math.round((nw * m.height) / m.width);
+
+        const dw = nw > m.width ? m.width : nw;
+        const dh = nh > m.height ? m.height : nh;
+        if (f.total < 9999) {
+            log.show(logTag, `${f.index}/${f.total}`,
+                helper.pathShort(fileSrc, 32),
+                `${m.width}x${m.height}=>${dw}x${dh} ${helper.humanSize(st.size)}`
+            );
+        }
+        log.fileLog(`Pre: ${f.index}/${f.total} <${fileSrc}> ` +
+            `${dw}x${dh}) ${m.format} ${helper.humanSize(st.size)}`, logTag);
+        return {
+            ...f,
+            width: dw,
+            height: dh,
+            src: fileSrc,
+            dst: fileDst,
+            tmpDst: fileDstTmp,
+        };
+    } catch (error) {
+        log.warn(logTag, "sharp", error.message, fileSrc);
+        log.fileLog(`SharpErr: ${f.index} <${fileSrc}> sharp:${error.message}`, logTag);
+    }
+}
+
+
+async function purgeSrcFiles(results) {
+    const logTag = "Purge";
+    const toDelete = results.filter(t => t?.src && t.dstExists && t.dst);
+    const total = toDelete?.length ?? 0;
+    if (total <= 0) {
+        return;
+    }
+    const answer = await inquirer.prompt([
+        {
+            type: "confirm",
+            name: "yes",
+            default: false,
+            message: chalk.bold.red(
+                `Are you sure to delete ${total} original files?`
+            ),
+        },
+    ]);
+    if (!answer.yes) {
+        log.showYellow("Will do nothing, aborted by user.");
+        return;
+    }
+    const deletecFunc = async (td, index) => {
+        const srcExists = await fs.pathExists(td.src);
+        const dstExists = await fs.pathExists(td.dst);
+        log.info(logTag, `Check S=${srcExists} D=${dstExists} ${helper.pathShort(td.src)}`)
+        // 确认文件存在，确保不会误删除
+        if (!(srcExists && dstExists)) {
+            return;
+        }
+        await fs.pathExists(td.tmpDst) && await fs.remove(td.tmpDst);
+        await helper.safeRemove(td.src);
+        log.showYellow(logTag, `SafeDel: ${index}/${total} ${helper.pathShort(td.src)}`);
+        log.fileLog(`SafeDel: <${td.dst}>`, logTag);
+        return td.src;
+    }
+    const deleted = await pMap(toDelete, deletecFunc, { concurrency: cpus().length * 8 })
+    log.showCyan(logTag, `${deleted.filter(Boolean).length} files are safely removed`);
+
+}

package/cmd/cmd_dcim.js

@@ -0,0 +1,169 @@
+/*
+ * File: cmd_dcim.js
+ * Created: 2024-03-16 21:04:01
+ * Modified: 2024-03-23 11:51:18
+ * Author: mcxiaoke (github@mcxiaoke.com)
+ * License: Apache License 2.0
+ */
+
+import chalk from 'chalk';
+import fs from 'fs-extra';
+import inquirer from "inquirer";
+import path from "path";
+
+import { renameFiles } from "./cmd_shared.js";
+
+import * as log from '../lib/debug.js';
+import * as exif from '../lib/exif.js';
+import * as helper from '../lib/helper.js';
+
+const LOG_TAG = "DcimR";
+
+export { aliases, builder, command, describe, handler };
+
+const command = "dcimr <input> [options]"
+const aliases = ["dm", "dcim"]
+const describe = 'Rename media files by exif metadata eg. date'
+
+const builder = function addOptions(ya, helpOrVersionSet) {
+    return ya.option("backup", {
+        // 备份原石文件
+        alias: "b",
+        type: "boolean",
+        default: false,
+        description: "backup original file before rename",
+    })
+        .option("fast", {
+            // 快速模式，使用文件修改时间，不解析EXIF
+            alias: "f",
+            type: "boolean",
+            description: "fast mode (use file modified time, no exif parse)",
+        })
+        .option("prefix", {
+            // 重命名后的文件前缀
+            alias: "p",
+            type: "string",
+            default: "IMG_/DSC_/VID_",
+            description: "custom filename prefix for raw/image/video files'",
+        })
+        .option("suffix", {
+            // 重命名后的后缀
+            alias: "s",
+            type: "string",
+            default: "",
+            description: "custom filename suffix",
+        })
+        .option("template", {
+            // 文件名模板，使用dayjs日期格式
+            alias: "t",
+            type: "string",
+            default: "YYYYMMDD_HHmmss",
+            description:
+                "filename date format template, see https://day.js.org/docs/en/display/format",
+        })
+        // 确认执行所有系统操作，非测试模式，如删除和重命名和移动操作
+        .option("doit", {
+            alias: "d",
+            type: "boolean",
+            default: false,
+            description: "execute os operations in real mode, not dry run",
+        })
+}
+
+
+const handler = async function cmdRename(argv) {
+    log.show(LOG_TAG, argv);
+    const root = path.resolve(argv.input);
+    if (!(await fs.pathExists(root))) {
+        log.error(`Invalid Input: '${root}'`);
+        throw new Error(`Invalid Input: '${root}'`)
+    }
+    const testMode = !argv.doit;
+    const fastMode = argv.fast || false;
+    // action: rename media file by exif date
+    const startMs = Date.now();
+    log.show(LOG_TAG, `Input: ${root}`);
+    let files = await exif.listMedia(root);
+    const fileCount = files.length;
+    log.show(LOG_TAG, `Total ${files.length} media files found`);
+
+    const confirmFiles = await inquirer.prompt([
+        {
+            type: "confirm",
+            name: "yes",
+            default: false,
+            message: chalk.bold.green(`Press y to continue processing...`),
+        },
+    ]);
+    if (!confirmFiles.yes) {
+        log.showYellow("Will do nothing, aborted by user.");
+        return;
+    }
+    log.show(LOG_TAG, `Processing files, reading EXIF data...`);
+    files = await exif.parseFiles(files, { fastMode });
+    log.show(
+        LOG_TAG,
+        `Total ${files.length} media files parsed`,
+        fastMode ? "(FastMode)" : ""
+    );
+    files = exif.buildNames(files);
+    const [validFiles, skippedBySize, skippedByDate] = exif.checkFiles(files);
+    files = validFiles;
+    if (fileCount - files.length > 0) {
+        log.warn(
+            LOG_TAG,
+            `Total ${fileCount - files.length} media files skipped`
+        );
+    }
+    log.show(
+        LOG_TAG,
+        `Total ${fileCount} files processed in ${helper.humanTime(startMs)}`,
+        fastMode ? "(FastMode)" : ""
+    );
+    if (skippedBySize.length > 0) {
+        log.showYellow(
+            LOG_TAG,
+            `Total ${skippedBySize.length} media files are skipped by size`
+        );
+    }
+    if (skippedByDate.length > 0) {
+        log.showYellow(
+            LOG_TAG,
+            `Total ${skippedByDate.length} media files are skipped by date`
+        );
+    }
+    if (files.length == 0) {
+        log.showYellow(LOG_TAG, "Nothing to do, exit now.");
+        return;
+    }
+    log.show(
+        LOG_TAG,
+        `Total ${files.length} media files ready to rename by exif`,
+        fastMode ? "(FastMode)" : ""
+    );
+    log.show(LOG_TAG, `task sample:`, files.slice(-2))
+    log.info(LOG_TAG, argv);
+    testMode && log.showYellow("++++++++++ TEST MODE (DRY RUN) ++++++++++")
+    const answer = await inquirer.prompt([
+        {
+            type: "confirm",
+            name: "yes",
+            default: false,
+            message: chalk.bold.red(
+                `Are you sure to rename ${files.length} files?` +
+                (fastMode ? " (FastMode)" : "")
+            ),
+        },
+    ]);
+    if (answer.yes) {
+        if (testMode) {
+            log.showYellow(LOG_TAG, `All ${files.length} files, NO file renamed in TEST MODE.`);
+        }
+        else {
+            const results = await renameFiles(files);
+            log.showGreen(LOG_TAG, `All ${results.length} file were renamed.`,);
+        }
+    } else {
+        log.showYellow(LOG_TAG, "Will do nothing, aborted by user.");
+    }
+}