image-classifier-ts
Version:
Command line tool to auto-classify images, renaming them with appropriate labels. Uses Node and Google Vision API.
335 lines • 17.2 kB
JavaScript
;
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.DirectoryProcessor = void 0;
var fs = require("fs");
var path = require("path");
var ImageClassifier_1 = require("./classify/ImageClassifier");
var GeoCoder_1 = require("./geoCode/GeoCoder");
var ImageMover_1 = require("./ImageMover");
var ImageProperties_1 = require("./model/ImageProperties");
var ConsoleReporter_1 = require("./utils/ConsoleReporter");
var ExifUtils_1 = require("./utils/ExifUtils");
var ImageDimensions_1 = require("./utils/ImageDimensions");
var MapDateToLocationManager_1 = require("./utils/MapDateToLocationManager");
var Verbosity_1 = require("./utils/output/Verbosity");
var EnvironmentVariables_1 = require("./utils/EnvironmentVariables");
var hasError = false;
var DELAY_BETWEEN_API_REQUESTS_IN_MILLIS = 1000 / 20;
var DirectoryProcessor;
(function (DirectoryProcessor) {
function processDirectory(args, outputter) {
return __awaiter(this, void 0, void 0, function () {
var results, error_1;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
_a.trys.push([0, 2, , 3]);
EnvironmentVariables_1.EnvironmentVariables.validateOrThrow();
return [4 /*yield*/, processImageDirectory(args, outputter)];
case 1:
results = _a.sent();
dumpResults(results.resultsByPhase, outputter);
outputter.infoVerbose("[processDirectory] - done");
return [2 /*return*/, Object.assign(results, {
isOk: !hasError
})];
case 2:
error_1 = _a.sent();
outputter.error("[processDirectory] error", error_1);
return [2 /*return*/, {
imageProperties: [],
resultsByPhase: new Map(),
isOk: false
}];
case 3: return [2 /*return*/];
}
});
});
}
DirectoryProcessor.processDirectory = processDirectory;
})(DirectoryProcessor = exports.DirectoryProcessor || (exports.DirectoryProcessor = {}));
function dumpResults(results, outputter) {
results.forEach(function (value, key) {
outputter.info(Phase[key], " - images processed: ".concat(value.imagesProcessedOk));
});
}
var handleError = function (err, outputter) {
if (err) {
outputter.error(err);
hasError = true;
}
};
var finish = function (fileCount, outputter) {
outputter.info("\n".concat(fileCount, " files were processed"));
if (hasError) {
outputter.error("errors occurred");
process.exit(777);
}
};
var isFileExtensionOk = function (filepath) {
if (filepath.endsWith(".dropbox")) {
return false;
}
// extensions - works for files with something before the '.'
var ext = path.extname(filepath);
var goodExtensions = [".jpg", ".jpeg", ".png"];
return goodExtensions.some(function (goodExt) { return goodExt.toLowerCase() === ext.toLowerCase(); });
};
var isDirectory = function (filepath) {
return fs.lstatSync(filepath).isDirectory();
};
var Phase;
(function (Phase) {
Phase[Phase["GeoCode"] = 0] = "GeoCode";
Phase[Phase["ClassifyAndMove"] = 1] = "ClassifyAndMove";
})(Phase || (Phase = {}));
function processImageDirectory(args, outputter) {
return __awaiter(this, void 0, void 0, function () {
var readdirPromise, files, resultsByPhase, error_2, imageProperties, mapDateToLocationManager, geoResult, classifyResult;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
readdirPromise = function () {
return new Promise(function (ok, notOk) {
fs.readdir(args.imageInputDir, function (err, _files) {
if (err) {
notOk(err);
}
else {
ok(_files);
}
});
});
};
resultsByPhase = new Map();
_a.label = 1;
case 1:
_a.trys.push([1, 3, , 4]);
return [4 /*yield*/, readdirPromise()];
case 2:
files = _a.sent();
return [3 /*break*/, 4];
case 3:
error_2 = _a.sent();
outputter.error(error_2);
return [2 /*return*/, {
imageProperties: [],
resultsByPhase: resultsByPhase
}];
case 4:
outputter.info("found ".concat(files.length, " files to process"));
imageProperties = getAllImageProperties(files, args, outputter);
mapDateToLocationManager = MapDateToLocationManager_1.MapDateToLocationManager.fromImageDirectory(args.imageInputDir, args.options);
logThisPhase(Phase.GeoCode, outputter);
if (!args.options.geoCode) return [3 /*break*/, 6];
return [4 /*yield*/, processImagesForPhase(imageProperties, Phase.GeoCode, args, mapDateToLocationManager, outputter)];
case 5:
geoResult = _a.sent();
resultsByPhase.set(Phase.GeoCode, geoResult);
return [3 /*break*/, 7];
case 6:
outputter.info("geo locate: skipping - geo locate option is not enabled");
_a.label = 7;
case 7:
mapDateToLocationManager.dumpAutoMapToDisk(args.imageInputDir);
logThisPhase(Phase.ClassifyAndMove, outputter);
return [4 /*yield*/, processImagesForPhase(imageProperties, Phase.ClassifyAndMove, args, mapDateToLocationManager, outputter)];
case 8:
classifyResult = _a.sent();
resultsByPhase.set(Phase.ClassifyAndMove, classifyResult);
return [2 /*return*/, {
resultsByPhase: resultsByPhase,
imageProperties: classifyResult.imageProperties
}];
}
});
});
}
function logThisPhase(phase, outputter) {
outputter.info("\n=== ".concat(Phase[phase], " phase ==="));
}
function getAllImageProperties(files, args, outputter) {
return files
.map(function (filepath) {
var imagePath = path.join(args.imageInputDir, filepath);
if (isDirectory(imagePath) || !isFileExtensionOk(imagePath)) {
outputter.warnVerbose("\nskipping file ".concat(imagePath, " (is dir or a skipped file extension)"));
return null;
}
return new ImageProperties_1.ImageProperties(imagePath, [], ExifUtils_1.ExifUtils.readFile(imagePath, outputter) || undefined, ImageDimensions_1.ImageDimensions.getDimensions(imagePath));
})
.filter(function (f) { return !!f; });
}
function processImagesForPhase(imageProperties, phase, args, mapDateToLocationManager, outputter) {
return __awaiter(this, void 0, void 0, function () {
var _this = this;
return __generator(this, function (_a) {
return [2 /*return*/, new Promise(function (resolve, reject) {
var result = {
imageProperties: [],
imagesProcessedOk: 0
};
var i = 0;
var doNextImage = function () { return __awaiter(_this, void 0, void 0, function () {
var thisImageProperties, isOk, _a, classifyResult, geoProperties, err_1;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
if (!(i < imageProperties.length)) return [3 /*break*/, 10];
thisImageProperties = imageProperties[i];
isOk = true;
_b.label = 1;
case 1:
_b.trys.push([1, 8, , 9]);
outputter.infoVerbose("\n");
outputter.info("processing image at ".concat(thisImageProperties.imagePath));
_a = phase;
switch (_a) {
case Phase.ClassifyAndMove: return [3 /*break*/, 2];
case Phase.GeoCode: return [3 /*break*/, 4];
}
return [3 /*break*/, 6];
case 2: return [4 /*yield*/, doClassifyPhaseForImage(thisImageProperties, args, mapDateToLocationManager, outputter)];
case 3:
classifyResult = _b.sent();
if (classifyResult.wasMoved) {
result.imagesProcessedOk++;
}
result.imageProperties.push(classifyResult.imageProperty);
return [3 /*break*/, 7];
case 4: return [4 /*yield*/, doGeoCodePhaseForImage(thisImageProperties, args.options, mapDateToLocationManager.autoMap, outputter)];
case 5:
geoProperties = _b.sent();
if (geoProperties.location) {
Object.assign(thisImageProperties, {
location: geoProperties.location
});
}
if (geoProperties.location) {
result.imagesProcessedOk++;
}
result.imageProperties.push(geoProperties);
return [3 /*break*/, 7];
case 6: throw new Error("unhandled Phase ".concat([phase]));
case 7: return [3 /*break*/, 9];
case 8:
err_1 = _b.sent();
outputter.errorVerbose("DP: error");
handleError(err_1, outputter);
isOk = false;
return [3 /*break*/, 9];
case 9:
if (!isOk) {
handleError("DP: error occurred", outputter);
}
i++;
if (i < imageProperties.length) {
setTimeout(function () {
doNextImage();
}, getDelayForPhase(phase));
}
else {
finish(imageProperties.length, outputter);
resolve(result);
}
_b.label = 10;
case 10: return [2 /*return*/];
}
});
}); };
doNextImage();
})];
});
});
}
function doClassifyPhaseForImage(properties, args, mapDateToLocationManager, outputter) {
return __awaiter(this, void 0, void 0, function () {
var imageProps, wasMoved;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, ImageClassifier_1.ImageClassifier.classifyImage(properties, args.options, outputter)];
case 1:
imageProps = _a.sent();
ConsoleReporter_1.ConsoleReporter.report(imageProps, outputter);
wasMoved = false;
if (!args.options.dryRun) return [3 /*break*/, 2];
ImageMover_1.ImageMover.dryRunMove(imageProps, args.options, args.imageOutputDir, mapDateToLocationManager, outputter);
return [3 /*break*/, 4];
case 2: return [4 /*yield*/, ImageMover_1.ImageMover.move(imageProps, args.options, args.imageOutputDir, mapDateToLocationManager, outputter)];
case 3:
wasMoved = _a.sent();
_a.label = 4;
case 4: return [2 /*return*/, {
imageProperty: imageProps,
wasMoved: wasMoved
}];
}
});
});
}
function doGeoCodePhaseForImage(properties, options, autoMapDateToLocation, outputter) {
return __awaiter(this, void 0, void 0, function () {
var geoProps;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, GeoCoder_1.GeoCoder.processImage(properties, options, autoMapDateToLocation, outputter)];
case 1:
geoProps = _a.sent();
if (outputter.verbosity === Verbosity_1.Verbosity.High) {
ConsoleReporter_1.ConsoleReporter.report(geoProps, outputter);
}
return [2 /*return*/, geoProps];
}
});
});
}
// Google API quota seems to be average rate per second
// rather than 'total within 100s'.
//
// so deliberately slowing down the request rate, to avoid hitting the quota:
function getDelayForPhase(phase) {
switch (phase) {
case Phase.ClassifyAndMove:
case Phase.GeoCode:
return DELAY_BETWEEN_API_REQUESTS_IN_MILLIS;
default:
throw new Error("unhandled Phase ".concat([phase]));
}
}
//# sourceMappingURL=DirectoryProcessor.js.map