antfarm/lib/job/file.js

File automation framework for ants.

"use strict";
var mime = require("mime-types"), fileExtension = require("file-extension"), node_path = require("path"), fs = require("fs"), filesize = require("filesize");
var File = (function () {
    /**
     * File constructor
     * @param e
     * @param path
     */
    function File(e, path) {
        this.e = e;
        this._path = path;
        // verify _path leads to a valid, readable file, handle error if not
        this.getStatistics();
    }
    /**
     * Refresh the file statistics after a rename or modification.
     */
    File.prototype.getStatistics = function () {
        var f = this;
        f._contentType = mime.lookup(f.path);
        f._extension = fileExtension(f.path);
        f._basename = node_path.basename(f.path);
        f._dirname = node_path.dirname(f.path);
        try {
            f._sizeBytes = fs.statSync(f.path).size;
        }
        catch (err) {
            f.e.log(2, "Couldn't determine sizeBytes with statSync. " + err, f);
            f._sizeBytes = 0;
        }
    };
    Object.defineProperty(File.prototype, "name", {
        /**
         * Get the _basename.
         * @returns {string}
         */
        get: function () {
            return this._basename;
        },
        /**
         * Set a new file _name.
         * @param filename
         */
        set: function (filename) {
            this._basename = filename;
        },
        enumerable: true,
        configurable: true
    });
    Object.defineProperty(File.prototype, "nameProper", {
        /**
         * Get the file _name of the job without the file extension.
         * @returns {string}
         */
        get: function () {
            return node_path.basename(this.basename, node_path.extname(this.basename));
        },
        enumerable: true,
        configurable: true
    });
    Object.defineProperty(File.prototype, "dirname", {
        /**
         * Get the top level directory _name.
         * @returns {string}
         */
        get: function () {
            return this._dirname;
        },
        enumerable: true,
        configurable: true
    });
    Object.defineProperty(File.prototype, "path", {
        /**
         * Get the complete directory _path.
         * @returns {string}
         */
        get: function () {
            return this._path;
        },
        /**
         * Set the complete directory _path.
         * @param path
         */
        set: function (path) {
            this._path = path;
            this.getStatistics();
        },
        enumerable: true,
        configurable: true
    });
    Object.defineProperty(File.prototype, "contentType", {
        /**
         * Get the content-type of the file.
         * @returns {string}
         */
        get: function () {
            return this._contentType;
        },
        enumerable: true,
        configurable: true
    });
    Object.defineProperty(File.prototype, "extension", {
        /**
         * Get the file extension.
         * @returns {string}
         */
        get: function () {
            return this._extension;
        },
        enumerable: true,
        configurable: true
    });
    Object.defineProperty(File.prototype, "basename", {
        /**
         * Get the _basename.
         * @returns {string}
         */
        get: function () {
            return this._basename;
        },
        enumerable: true,
        configurable: true
    });
    Object.defineProperty(File.prototype, "sizeBytes", {
        get: function () {
            return this._sizeBytes;
        },
        enumerable: true,
        configurable: true
    });
    Object.defineProperty(File.prototype, "size", {
        get: function () {
            return filesize(this.sizeBytes);
        },
        enumerable: true,
        configurable: true
    });
    /**
     * Renames the local job file to the current _name.
     */
    File.prototype.renameLocal = function () {
        var f = this;
        var new_path = f.dirname + node_path.sep + f.name;
        fs.renameSync(f.path, new_path);
        f.path = new_path;
        f.getStatistics();
    };
    /**
     * Deletes the local file.
     * @returns {boolean}
     */
    File.prototype.removeLocal = function () {
        var f = this;
        try {
            fs.unlinkSync(f.path);
            return true;
        }
        catch (e) {
            f.e.log(3, "File \"" + f.path + "\" could not be deleted. " + e, f);
            return false;
        }
    };
    return File;
}());
exports.File = File;

//# sourceMappingURL=data:application/json;charset=utf8;base64,{"version":3,"sources":["lib/job/file.ts"],"names":[],"mappings":";AAEA,IAAQ,IAAI,GAAG,OAAO,CAAC,YAAY,CAAC,EAC5B,aAAa,GAAG,OAAO,CAAC,gBAAgB,CAAC,EACzC,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,EAC3B,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,EAClB,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;AAEvC;IAUI;;;;OAIG;IACH,cAAY,CAAc,EAAE,IAAY;QACpC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QACX,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAElB,oEAAoE;QAEpE,IAAI,CAAC,aAAa,EAAE,CAAC;IACzB,CAAC;IAED;;OAEG;IACO,4BAAa,GAAvB;QACI,IAAI,CAAC,GAAG,IAAI,CAAC;QACb,CAAC,CAAC,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACrC,CAAC,CAAC,UAAU,GAAG,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACrC,CAAC,CAAC,SAAS,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACzC,CAAC,CAAC,QAAQ,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,CAAC;YACD,CAAC,CAAC,UAAU,GAAG,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC;QAC5C,CAAE;QAAA,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YACX,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,iDAA+C,GAAK,EAAE,CAAC,CAAC,CAAC;YACpE,CAAC,CAAC,UAAU,GAAG,CAAC,CAAC;QACrB,CAAC;IACL,CAAC;IAMD,sBAAW,sBAAI;QAJf;;;WAGG;aACH;YACI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;QAC1B,CAAC;QAED;;;WAGG;aACH,UAAgB,QAAgB;YAC5B,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC9B,CAAC;;;OARA;IAcD,sBAAW,4BAAU;QAJrB;;;WAGG;aACH;YACI,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC/E,CAAC;;;OAAA;IAMD,sBAAW,yBAAO;QAJlB;;;WAGG;aACH;YACI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;QACzB,CAAC;;;OAAA;IAMD,sBAAW,sBAAI;QAJf;;;WAGG;aACH;YACI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;QACtB,CAAC;QAED;;;WAGG;aACH,UAAgB,IAAY;YACxB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;YAClB,IAAI,CAAC,aAAa,EAAE,CAAC;QACzB,CAAC;;;OATA;IAeD,sBAAW,6BAAW;QAJtB;;;WAGG;aACH;YACI,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC;QAC7B,CAAC;;;OAAA;IAMD,sBAAW,2BAAS;QAJpB;;;WAGG;aACH;YACI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC;QAC3B,CAAC;;;OAAA;IAMD,sBAAW,0BAAQ;QAJnB;;;WAGG;aACH;YACI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;QAC1B,CAAC;;;OAAA;IAED,sBAAW,2BAAS;aAApB;YACI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC;QAC3B,CAAC;;;OAAA;IAED,sBAAW,sBAAI;aAAf;YACI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACpC,CAAC;;;OAAA;IAED;;OAEG;IACI,0BAAW,GAAlB;QACI,IAAI,CAAC,GAAG,IAAI,CAAC;QACb,IAAI,QAAQ,GAAG,CAAC,CAAC,OAAO,GAAG,SAAS,CAAC,GAAG,GAAG,CAAC,CAAC,IAAI,CAAC;QAClD,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAChC,CAAC,CAAC,IAAI,GAAG,QAAQ,CAAC;QAClB,CAAC,CAAC,aAAa,EAAE,CAAC;IACtB,CAAC;IAED;;;OAGG;IACI,0BAAW,GAAlB;QACI,IAAI,CAAC,GAAG,IAAI,CAAC;QACb,IAAI,CAAC;YACD,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YACtB,MAAM,CAAC,IAAI,CAAC;QAChB,CAAE;QAAA,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACT,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,YAAS,CAAC,CAAC,IAAI,iCAA2B,CAAG,EAAE,CAAC,CAAC,CAAC;YAC7D,MAAM,CAAC,KAAK,CAAC;QACjB,CAAC;IACL,CAAC;IAEL,WAAC;AAAD,CApJA,AAoJC,IAAA;AApJY,YAAI,OAoJhB,CAAA","file":"lib/job/file.js","sourcesContent":["import {Environment} from \"../environment/environment\";\n\nconst   mime = require(\"mime-types\"),\n        fileExtension = require(\"file-extension\"),\n        node_path = require(\"path\"),\n        fs = require(\"fs\"),\n        filesize = require(\"filesize\");\n\nexport class File {\n\n    protected _path: string;\n    protected _dirname: string;\n    protected _basename: string;\n    protected _contentType: string;\n    protected _extension: string;\n    protected _sizeBytes: number;\n    protected e: Environment;\n\n    /**\n     * File constructor\n     * @param e\n     * @param path\n     */\n    constructor(e: Environment, path: string) {\n        this.e = e;\n        this._path = path;\n\n        // verify _path leads to a valid, readable file, handle error if not\n\n        this.getStatistics();\n    }\n\n    /**\n     * Refresh the file statistics after a rename or modification.\n     */\n    protected getStatistics() {\n        let f = this;\n        f._contentType = mime.lookup(f.path);\n        f._extension = fileExtension(f.path);\n        f._basename = node_path.basename(f.path);\n        f._dirname = node_path.dirname(f.path);\n        try {\n            f._sizeBytes = fs.statSync(f.path).size;\n        } catch (err) {\n            f.e.log(2, `Couldn't determine sizeBytes with statSync. ${err}`, f);\n            f._sizeBytes = 0;\n        }\n    }\n\n    /**\n     * Get the _basename.\n     * @returns {string}\n     */\n    public get name() {\n        return this._basename;\n    }\n\n    /**\n     * Set a new file _name.\n     * @param filename\n     */\n    public set name(filename: string) {\n        this._basename = filename;\n    }\n\n    /**\n     * Get the file _name of the job without the file extension.\n     * @returns {string}\n     */\n    public get nameProper() {\n        return node_path.basename(this.basename, node_path.extname(this.basename));\n    }\n\n    /**\n     * Get the top level directory _name.\n     * @returns {string}\n     */\n    public get dirname() {\n        return this._dirname;\n    }\n\n    /**\n     * Get the complete directory _path.\n     * @returns {string}\n     */\n    public get path() {\n        return this._path;\n    }\n\n    /**\n     * Set the complete directory _path.\n     * @param path\n     */\n    public set path(path: string) {\n        this._path = path;\n        this.getStatistics();\n    }\n\n    /**\n     * Get the content-type of the file.\n     * @returns {string}\n     */\n    public get contentType() {\n        return this._contentType;\n    }\n\n    /**\n     * Get the file extension.\n     * @returns {string}\n     */\n    public get extension() {\n        return this._extension;\n    }\n\n    /**\n     * Get the _basename.\n     * @returns {string}\n     */\n    public get basename() {\n        return this._basename;\n    }\n\n    public get sizeBytes() {\n        return this._sizeBytes;\n    }\n\n    public get size() {\n        return filesize(this.sizeBytes);\n    }\n\n    /**\n     * Renames the local job file to the current _name.\n     */\n    public renameLocal() {\n        let f = this;\n        let new_path = f.dirname + node_path.sep + f.name;\n        fs.renameSync(f.path, new_path);\n        f.path = new_path;\n        f.getStatistics();\n    }\n\n    /**\n     * Deletes the local file.\n     * @returns {boolean}\n     */\n    public removeLocal() {\n        let f = this;\n        try {\n            fs.unlinkSync(f.path);\n            return true;\n        } catch (e) {\n            f.e.log(3, `File \"${f.path}\" could not be deleted. ${e}`, f);\n            return false;\n        }\n    }\n\n}"]}