/*
 * Copyright (c) 2014 Adobe Systems Incorporated. All rights reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 *
 */

(function () {
    "use strict";

    var util = require("util"),
        assert = require("assert"),
        events = require("events"),
        path = require("path");

    var Bounds = require("./bounds"),
        Raw = require("./raw");

    var createLayer = require("./layer").createLayer;

    var DEBUG_TO_RAW_CONVERSION = false;
    
    var EXACT_BOUNDS_SETTINGS = {
        boundsOnly: true
    };

    var debugLogObject = function (objectName, object) {
        console.log("========== %s ==========", objectName);
        console.log(JSON.stringify(Raw.sortJSON(object), null, 4));
        console.log("========================");
    };

    /**
     * Model of a Photoshop document.
     * 
     * @constructor
     * @param {Generator} generator
     * @param {object} config
     * @param {Logger} logger
     * @param {object} raw Raw description of the document
     */
    function Document(generator, config, logger, raw) {
        if (DEBUG_TO_RAW_CONVERSION) {
            debugLogObject("raw", raw);
        }

        events.EventEmitter.call(this);
        
        this._generator = generator;
        this._config = config;
        this._logger = logger;


        var property;
        for (property in raw) {
            if (raw.hasOwnProperty(property)) {
                switch (property) {
                case "id":
                    this._id = raw.id;
                    break;
                case "count":
                    this._count = raw.count;
                    break;
                case "timeStamp":
                    this._timeStamp = raw.timeStamp;
                    break;
                case "version":
                    this._version = raw.version;
                    break;
                case "file":
                    this._setFile(raw.file);
                    break;
                case "bounds":
                    this._setBounds(raw.bounds);
                    break;
                case "selection":
                    // Resolving the selection depends on the layers; set it in a later pass
                    break;
                case "resolution":
                    this._setResolution(raw.resolution);
                    break;
                case "globalLight":
                    this._setGlobalLight(raw.globalLight);
                    break;
                case "generatorSettings":
                    this._setGeneratorSettings(raw.generatorSettings);
                    break;
                case "layers":
                    this._setLayers(raw.layers);
                    break;
                case "comps":
                    this._setComps(raw.comps);
                    break;
                case "placed":
                    this._setPlaced(raw.placed);
                    break;
                case "profile":
                case "mode":
                case "depth":
                    // Do nothing for these properties
                    // TODO could profile and/or mode be helpful for embedding color profile?
                    break;
                default:
                    this._logger.warn("Unhandled property in raw constructor:", property, raw[property]);
                }
            }
        }

        if (raw.hasOwnProperty("selection")) {
            this._setSelection(raw.selection);
        }

        if (DEBUG_TO_RAW_CONVERSION) {
            debugLogObject("document.toRaw", this.toRaw());
        }
    }

    util.inherits(Document, events.EventEmitter);

    Object.defineProperties(Document.prototype, {
        "id": {
            get: function () { return this._id; },
            set: function () { throw new Error("Cannot set id"); }
        },
        "count": {
            get: function () { return this._count; },
            set: function () { throw new Error("Cannot set count"); }
        },
        "timeStamp": {
            get: function () { return this._timeStamp; },
            set: function () { throw new Error("Cannot set timeStamp"); }
        },
        "version": {
            get: function () { return this._version; },
            set: function () { throw new Error("Cannot set version"); }
        },
        "file": {
            get: function () { return this._file; },
            set: function () { throw new Error("Cannot set file"); }
        },
        "name": {
            get: function () { return this._name; },
            set: function () { throw new Error("Cannot set name"); }
        },
        "extension": {
            get: function () { return this._extension; },
            set: function () { throw new Error("Cannot set extension"); }
        },
        "basename": {
            get: function () { return path.basename(this.name, this.extension); },
            set: function () { throw new Error("Cannot set basename"); }
        },
        "directory": {
            get: function () { return this._directory; },
            set: function () { throw new Error("Cannot set directory"); }
        },
        "saved": {
            get: function () { return !!this._directory; },
            set: function () { throw new Error("Cannot set saved"); }
        },
        "bounds": {
            get: function () { return this._bounds; },
            set: function () { throw new Error("Cannot set bounds"); }
        },
        "selection": {
            get: function () { return this._selection; },
            set: function () { throw new Error("Cannot set selection"); }
        },
        "resolution": {
            get: function () { return this._resolution; },
            set: function () { throw new Error("Cannot set resolution"); }
        },
        "globalLight": {
            get: function () { return this._globalLight; },
            set: function () { throw new Error("Cannot set globalLight"); }
        },
        "generatorSettings": {
            get: function () { return this._generatorSettings; },
            set: function () { throw new Error("Cannot set generatorSettings"); }
        },
        "layers": {
            get: function () { return this._layers; },
            set: function () { throw new Error("Cannot set layers"); }
        },
        "comps": {
            get: function () { return this._comps; },
            set: function () { throw new Error("Cannot set comps"); }
        },
        "placed": {
            get: function () { return this._placed; },
            set: function () { throw new Error("Cannot set placed"); }
        }
    });

    /**
     * @type {number}
     */
    Document.prototype._id = null;

    /**
     * @type {string}
     */
    Document.prototype._version = null;

    /**
     * @type {number}
     */
    Document.prototype._count = null;

    /**
     * @type {number}
     */
    Document.prototype._timeStamp = null;

    /**
     * @type {string}
     */
    Document.prototype._file = null;

    /**
     * @type {string}
     */
    Document.prototype._name = null;

    /**
     * @type {string}
     */
    Document.prototype._extension = null;

    /**
     * @type {string}
     */
    Document.prototype._directory = null;

    /**
     * @type {Bounds}
     */
    Document.prototype._bounds = null;

    /**
     * @type {{string, Layer}}
     * Map of currently selected layers. Keys are layer IDs as strings, values are Layer objects
     */
    Document.prototype._selection = null;

    /**
     * @type {number}
     */
    Document.prototype._resolution = null;

    /**
     * @type {{altitude: number, angle: number}}
     */
    Document.prototype._globalLight = null;

    /**
     * @type {string}
     */
    Document.prototype._generatorSettings = null;

    /**
     * @type {LayerGroup}
     */
    Document.prototype._layers = null;

    /**
     * @type {{number, Object}}
     */
    Document.prototype._placed = null;

    /**
     * @type {{number, Object}}
     */
    Document.prototype._comps = null;

    Document.prototype._setFile = function (rawFile) {
        this._file = rawFile;
        this._name = path.basename(rawFile);
        this._extension = path.extname(rawFile);

        if (rawFile.match(/[\/\\]/)) {
            this._directory = path.dirname(rawFile);
        } else {
            this._directory = null;
        }
    };

    Document.prototype._updateFile = function (rawFile) {
        var previousFile = this._file,
            previousName = this.name,
            previousExtension = this.extension,
            previousDirectory = this.directory,
            previousSaved = this.saved;

        if (previousFile !== rawFile) {
            this._setFile(rawFile);

            var change = {
                previous: previousFile
            };

            if (previousName !== this.name) {
                change.previousName = previousName;
            }

            if (previousExtension !== this.extension) {
                change.previousExtension = previousExtension;
            }

            if (previousDirectory !== this.directory) {
                change.previousDirectory = previousDirectory;
            }

            if (previousSaved !== this.saved) {
                change.previousSaved = previousSaved;
            }

            return change;
        }
    };

    Document.prototype._setSelection = function (rawSelection) {
        this._selection = rawSelection.reduce(function (prev, index) {
            var layer = this.layers.findLayerAtIndex(index);

            if (!layer) {
                throw new Error("Unable to set selection: no layer found at index " + index);
            }

            // DEBUG: confirm that the found layer's computed index matches the target index
            // assert.strictEqual(index, this.layers.findLayer(layer.id).index);

            prev[layer.id] = layer;
            return prev;
        }.bind(this), {});
    };

    Document.prototype._updateSelection = function (rawSelection) {
        var previousSelection = this._selection || {};
        this._setSelection(rawSelection);

        var previousKeys = Object.keys(previousSelection).sort(),
            currentKeys = Object.keys(this._selection).sort(),
            changed = currentKeys.length !== previousKeys.length ||
                currentKeys.some(function (layerId, index) {
                    return layerId !== previousKeys[index];
                });

        if (changed) {
            return {
                previous: previousSelection
            };
        }
    };

    Document.prototype._setBounds = function (rawBounds) {
        this._bounds = new Bounds(rawBounds);
    };

    Document.prototype._updateBounds = function (rawBounds) {
        return this._bounds._applyChange(rawBounds);
    };
    
    Document.prototype.getExactBounds = function (layerCompId, maxDimension) {
        var generator = this._generator,
            settings = JSON.parse(JSON.stringify(EXACT_BOUNDS_SETTINGS));
        
        if (maxDimension) {
            settings.maxDimension = maxDimension;
        }
        
        if (isFinite(layerCompId)) {
            settings.compId = layerCompId;
        }

        return generator.getDocumentPixmap(this.id, settings)
            .get("bounds")
            .then(function (rawBounds) {
                return new Bounds(rawBounds);
            }.bind(this));
    };

    Document.prototype._setResolution = function (rawResolution) {
        var ppi = parseFloat(rawResolution);

        if (isNaN(ppi)) {
            ppi = 72;
        }

        this._resolution = ppi;
    };

    Document.prototype._updateResolution = function (rawResolution) {
        var previousResolution = this._resolution;
        this._setResolution(rawResolution);

        return {
            previous: previousResolution
        };
    };

    Document.prototype._setGlobalLight = function (rawGlobalLight) {
        this._globalLight = rawGlobalLight;
    };

    Document.prototype._updateGlobalLight = function (rawGlobalLight) {
        var previousGlobalLight = this._globalLight;
        this._setGlobalLight(rawGlobalLight);

        return {
            previous: previousGlobalLight
        };
    };

    Document.prototype._setGeneratorSettings = function (rawGeneratorSettings) {
        this._generatorSettings = rawGeneratorSettings;
    };

    Document.prototype._updateGeneratorSettings = function (rawGeneratorSettings) {
        var previousGeneratorSettings = this._generatorSettings;
        this._setGeneratorSettings(rawGeneratorSettings);

        return {
            previous: previousGeneratorSettings,
            current: this.generatorSettings
        };
    };

    Document.prototype._setComps = function (raw) {
        this._comps = raw;
    };

    Document.prototype._updateComps = function (raw) {
        var rawCompChange = {
                id: this.id,
                comps: raw
            },
            changes = this._getChangedComps(rawCompChange.comps);
        return changes;
    };
    
    /**
     * Get a layer comp with the given id
     * @private
     * @param {identifier:number} compId
     * @return layerComp object
     */
    Document.prototype._findCompById = function (compId) {
        var ret;
        this._comps.some(function (comp) {
            if (String(comp.id) === String(compId)) {
                ret = comp;
            }
        });
        return ret;
    };
    
    /**
     * Traverse the set of rawCompChanges and collect the set of Comp objects referred to 
     * by the rawCompChanges.  The result is a set of changes.
     * @private
     * @param {Array.<object>} rawCompChanges
     * @param {Object} changes
     * @return compChangeLookup object
     */
    Document.prototype._getChangedComps = function (rawCompChanges, changes) {
        changes = changes || {};

        rawCompChanges.forEach(function (rawCompChange) {
            var id = rawCompChange.id,
                result;

            if (rawCompChange.added) {
                this._comps.push(rawCompChange);
                result = rawCompChange;
                result.type = "added";
            } else {
                result = this._findCompById(id);
                if (!result) {
                    this._logger.error("Error updating layer comp with id [" + id + "]");
                    return;
                }
                
                if (rawCompChange.removed) {
                    result.type = "removed";
                } else if (rawCompChange.hasOwnProperty("index")) {
                    result.type = "moved";
                } else {
                    result.type = "changed";
                    result.name = rawCompChange.name;
                }
            }
            changes[id] = result;
        }.bind(this));

        return changes;
    };
    

    Document.prototype._setPlaced = function (raw) {
        this._placed = raw;
    };

    Document.prototype._updatePlaced = function (raw) {
        var previous = this._placed;
        this._setPlaced(raw);

        return {
            previous: previous
        };
    };

    Document.prototype._setLayers = function (raw) {
        var rawLayer = {
            id: this.id,
            layers: raw
        };

        this._layers = createLayer(this, null, rawLayer);

        // DEBUG
        // this._validateLayerChanges(raw);
    };

    /**
     * Traverse the set of rawLayerChanges and collect the set of Layer objects in
     * the Document's current LayerGroup that are referred to by the rawLayerChanges.
     * The result is a set of change records, each of which contains: an index property
     * that describes where in the layer tree the layer will eventually reside; a reference
     * to the Layer object itself, if the rawLayerChange describes an existant layer
     * (i.e., not an "added" layer); and possibly a "type" property that, if it exists,
     * can be either "added", "removed" or "moved", which describes the type of structural
     * change that the layer has undergone.
     *
     * @private
     * @param {Array.<object>} rawLayerChanges
     * @param {{index: number, type: string=, layer: Layer}=} changes
     * @return {{index: number, type: string=, layer: Layer=}=}
     */
    Document.prototype._getChangedLayers = function (rawLayerChanges, changes) {
        changes = changes || {};

        rawLayerChanges.forEach(function (rawLayerChange) {
            var id = rawLayerChange.id,
                result;

            if (rawLayerChange.hasOwnProperty("layers")) {
                this._getChangedLayers(rawLayerChange.layers, changes);
            }

            if (rawLayerChange.added) {
                result = {
                    type: "added",
                    index: rawLayerChange.index
                };
            } else {
                result = this._layers.findLayer(id);

                if (!result) {
                    if (rawLayerChange.removed) {
                        // Phantom section/group end layer
                        return;
                    } else {
                        throw new Error("Can't find changed layer:", id);
                    }
                }

                if (rawLayerChange.removed) {
                    result.type = "removed";
                } else if (rawLayerChange.hasOwnProperty("index")) {
                    result.type = "moved";
                }
            }

            changes[id] = result;
        }, this);

        return changes;
    };

    /**
     * Augment an existing set of change records with additional change records that
     * correspond to "layersAdjusted" annotations on rawLayerChange descriptions.
     * 
     * @private
     * @param {Array.<object>} rawLayerChanges
     * @param {{index: number, type: string=, layer: Layer=}} changes
     */
    Document.prototype._addChangedLayerRanges = function (rawLayerChanges, changes) {
        rawLayerChanges.forEach(function (rawLayerChange) {
            if (rawLayerChange.hasOwnProperty("layers")) {
                this._addChangedLayerRanges(rawLayerChange.layers, changes);
            }

            var range;
            if (rawLayerChange.hasOwnProperty("layersAdjusted") &&
                rawLayerChange.layersAdjusted.hasOwnProperty("indexRange")) {
                range = rawLayerChange.layersAdjusted.indexRange;
            }

            if (rawLayerChange.hasOwnProperty("clipGroup") &&
                rawLayerChange.clipGroup.hasOwnProperty("indexRange")) {
                if (range) {
                    range[0] = Math.min(range[0], rawLayerChange.clipGroup.indexRange[0]);
                    range[1] = Math.max(range[1], rawLayerChange.clipGroup.indexRange[1]);
                } else {
                    range = rawLayerChange.clipGroup.indexRange;
                }
            }

            if (range) {
                var rangeStart = range[0],
                    rangeEnd = range[1],
                    layer,
                    index;

                for (index = rangeStart; index <= rangeEnd; index++) {
                    layer = this.layers.findLayerAtIndex(index);
                    if (!layer) {
                        // The index range likely contains phantom layerSection
                        // ends, which can safely be ignored
                        continue;
                    }

                    if (!changes.hasOwnProperty(layer.id)) {
                        changes[layer.id] = {
                            index: index,
                            layer: layer
                        };
                    }
                }
            }
        }, this);
    };

    /**
     * For each removed or added layer from a set of layer change records,
     * remove that layer from the Document's layer group.
     * 
     * @param {{index: number, type: string=, layer: Layer=}} changes
     */
    Document.prototype._detachMovedLayers = function (changes) {
        Object.keys(changes)
            .reduce(function (filteredChanges, id) {
                var change = changes[id];

                if (change.type === "moved" || change.type === "removed") {
                    filteredChanges.push(change);
                }
                return filteredChanges;
            }, [])
            .sort(function (l1, l2) {
                return l1.index - l2.index;
            })
            .forEach(function (change) {
                // remove the layer from its current position
                change.layer._detach();
            });
    };

    /**
     * Confirm that the indices referred to in a list of rawLayerChanges are
     * consistent with the locations of those layers in the Document's current
     * layer group. This is for debugging purposes only.
     * 
     * @param {Array.<object>} rawLayerChanges
     * @throws {Error} If the layer is not found in the layer group at the index
     *      mentioned in the rawLayerChange
     */
    Document.prototype._validateLayerChanges = function (rawLayerChanges) {
        rawLayerChanges.forEach(function (rawLayerChange) {
            if (rawLayerChange.hasOwnProperty("index")) {
                var index = rawLayerChange.index,
                    id = rawLayerChange.id,
                    result = this._layers.findLayer(id);

                if (rawLayerChange.removed) {
                    assert(!result, "Removed layer " + id + " still exists at index " + result.index);
                } else {
                    var message = "Layer " + id + " has index " + result.index + " instead of " + index;
                    assert.strictEqual(index, result.index, message);
                }

                if (rawLayerChange.hasOwnProperty("layers")) {
                    this._validateLayerChanges(rawLayerChange.layers);
                }
            }
        }, this);
    };

    /**
     * Given a raw change description for the Document's layer group, update the
     * Document's layer group and return a set of layer change records, indexed
     * by the changed layer's id.
     * 
     * @param {object} rawChange
     * @return {{number: {index: number, type: string=, layer: Layer=, changes: object}}}
     */
    Document.prototype._updateLayers = function (rawChange) {
        var rawLayerChange = {
            id: this.id,
            layers: rawChange
        };

        // Find all the existing layers that need to be updated
        var changes = this._getChangedLayers(rawLayerChange.layers);

        // Add in all the changed layer ranges
        this._addChangedLayerRanges(rawLayerChange.layers, changes);

        // Remove them from the tree
        this._detachMovedLayers(changes);

        // Add or re-add new layers to the tree at their new indexes
        this._layers._applyChange(rawLayerChange, changes);

        // DEBUG
        // this._validateLayerChanges(rawLayerChange.layers);

        return changes;
    };

    Document.prototype._applyChange = function (rawChange) {
        assert.strictEqual(this.id, rawChange.id, "Document ID mismatch");
        assert.strictEqual(this.version, rawChange.version, "Version mismatch.");

        if (this.timeStamp > rawChange.timeStamp ||
            (this.timeStamp === rawChange.timeStamp && this.count <= rawChange.count)) {
            console.warn("Skipping out of order change: this %d@%d; change %d@%d",
                this.count, this.timeStamp, rawChange.count, rawChange.timeStamp);
            return true;
        }

        if (rawChange.hasOwnProperty("changed")) {
            this.emit("end", "Unknown change");
            return false;
        }

        this._count = rawChange.count;
        this._timeStamp = rawChange.timeStamp;

        var changes = {},
            property,
            change;

        for (property in rawChange) {
            if (rawChange.hasOwnProperty(property)) {
                try {
                    switch (property) {
                    case "file":
                        change = this._updateFile(rawChange.file);
                        if (change) {
                            changes.file = change;
                        }
                        break;
                    case "globalLight":
                        change = this._updateGlobalLight(rawChange.globalLight);
                        if (change) {
                            changes.globalLight = change;
                        }
                        break;
                    case "bounds":
                        // TODO: Fix this in PS instead. PS does not notify us of the layer bounds changes when the
                        // document bounds change (from the Image Size dialog, Canvas Size dialog, Crop tool,
                        // resolution, etc.,). Since all layer bounds likely changed just re-request the whole docinfo.
                        // https://watsonexp.corp.adobe.com/#bug=3974492
                        throw new Error("Re-requesting docinfo due to document bounds change.");

                        // Ideally, we would just do this:
                        // change = this._updateBounds(rawChange.bounds);
                        // if (change) {
                        //     changes.bounds = change;
                        // }
                        // break;
                    case "resolution":
                        //see comment above for "bounds"
                        throw new Error("Re-requesting docinfo due to document resolution change.");
                        //change = this._updateResolution(rawChange.resolution);
                        //if (change) {
                        //    changes.resolution = change;
                        //}
                        //break;
                    case "selection":
                        // Resolving the selection depends on the layers; set it in a later pass
                        break;
                    case "generatorSettings":
                        change = this._updateGeneratorSettings(rawChange.generatorSettings);
                        if (change) {
                            changes.generatorSettings = change;
                        }
                        break;
                    case "layers":
                        change = this._updateLayers(rawChange.layers);
                        if (change) {
                            changes.layers = change;
                        }
                        break;
                    case "comps":
                        change = this._updateComps(rawChange.comps);
                        if (change) {
                            changes.comps = change;
                        }
                        break;
                    case "placed":
                        change = this._updatePlaced(rawChange.placed);
                        if (change) {
                            changes.placed = change;
                        }
                        break;
                    case "closed":
                        changes.closed = !!rawChange.closed;
                        break;
                    case "active":
                        changes.active = !!rawChange.active;
                        break;
                    case "merged":
                        changes.merged = !!rawChange.merged;
                        break;
                    case "flattened":
                        changes.flattened = !!rawChange.flattened;
                        break;
                    case "metaDataOnly":
                        changes.metaDataOnly = !!rawChange.metaDataOnly;
                        break;
                    case "id":
                    case "timeStamp":
                    case "count":
                    case "version":
                        // Do nothing for these properties
                        break;
                    default:
                        this._logger.warn("Unhandled property in raw change:", property, rawChange[property]);
                    }
                } catch (ex) {
                    this._logger.error("Error updating property", property, rawChange[property], ex);
                    this.emit("end", "Failed to apply change", property, rawChange[property], ex);
                    return false;
                }
            }
        }

        try {
            if (rawChange.hasOwnProperty("selection")) {
                change = this._updateSelection(rawChange.selection);
                if (change) {
                    changes.selection = change;
                }
            }
        } catch (ex) {
            this._logger.error("Error updating property", property, rawChange.selection, ex);
            this.emit("end", "Failed to apply change", property, rawChange.selection, ex);
            return false;
        }

        if (Object.keys(changes).length > 0) {
            var changeName;
            for (changeName in changes) {
                if (changes.hasOwnProperty(changeName)) {
                    this.emit(changeName, changes[changeName], changes.timeStamp, changes.count);
                }
            }

            changes.id = rawChange.id;
            changes.timeStamp = rawChange.timeStamp;
            changes.count = rawChange.count;
            this.emit("change", changes);
        }

        return true;
    };

    Document.prototype.toString = function () {
        var layerStrings = this._layers.layers.map(function (l) {
            return l.toString();
        });
        
        return "Document " + this._id + " [" + layerStrings.join(", ") + "]";
    };

    Document.prototype.toRaw = function () {
        var document = Raw.toRaw(this, [
            "id",
            "count",
            "timeStamp",
            "version",
            "file",
            "bounds",
            "resolution",
            "globalLight",
            "generatorSettings",
            "layers",
            "comps",
            "placed"
        ]);

        // Layers are nested in an extra LayerGroup for the document, so bring them up one level.
        document.layers = document.layers.layers;

        // The original docinfo selection is by layer index, which is harder to work with than by layer id.
        document._selectionById = Object.keys(this.selection).map(function (layerIdString) {
            return parseInt(layerIdString, 10);
        });

        return document;
    };

    module.exports = Document;
}());
