// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information.

namespace WixToolset.Core.WindowsInstaller.Bind
{
    using System;
    using System.Collections.Generic;
    using System.Diagnostics;
    using System.IO;
    using System.Linq;
    using WixToolset.Core.Bind;
    using WixToolset.Data;
    using WixToolset.Data.Tuples;
    using WixToolset.Data.WindowsInstaller;
    using WixToolset.Data.WindowsInstaller.Rows;
    using WixToolset.Extensibility;
    using WixToolset.Extensibility.Services;

    internal class GetFileFacadesFromTransforms
    {
        public GetFileFacadesFromTransforms(IMessaging messaging, IEnumerable<SubStorage> subStorages, TableDefinitionCollection tableDefinitions)
        {
            this.Messaging = messaging;
            this.SubStorages = subStorages;
            this.TableDefinitions = tableDefinitions;
        }

        public IEnumerable<IFileSystemExtension> Extensions { get; }

        private IMessaging Messaging { get; }

        public IEnumerable<SubStorage> SubStorages { get; }

        private TableDefinitionCollection TableDefinitions { get; }

        public IEnumerable<FileFacade> FileFacades { get; private set; }

        public void Execute()
        {
            var allFileRows = new List<FileFacade>();
            var copyToPatch = (allFileRows != null);
#if TODO_PATCHING
            var patchMediaRows = new RowDictionary<MediaRow>();

            var patchMediaFileRows = new Dictionary<int, RowDictionary<WixFileRow>>();

            var patchActualFileTable = this.Output.EnsureTable(this.TableDefinitions["File"]);
            var patchFileTable = this.Output.EnsureTable(this.TableDefinitions["WixFile"]);

            if (copyFromPatch)
            {
                // index patch files by diskId+fileId
                foreach (WixFileRow patchFileRow in patchFileTable.Rows)
                {
                    int diskId = patchFileRow.DiskId;
                    if (!patchMediaFileRows.TryGetValue(diskId, out var mediaFileRows))
                    {
                        mediaFileRows = new RowDictionary<WixFileRow>();
                        patchMediaFileRows.Add(diskId, mediaFileRows);
                    }

                    mediaFileRows.Add(patchFileRow);
                }

                var patchMediaTable = this.Output.EnsureTable(this.TableDefinitions["Media"]);
                patchMediaRows = new RowDictionary<MediaRow>(patchMediaTable);
            }

            // Index paired transforms by name without their "#" prefix.
            var pairedTransforms = this.SubStorages.Where(s => s.Name.StartsWith("#")).ToDictionary(s => s.Name.Substring(1), s => s.Data);

            foreach (var substorage in this.SubStorages)
            {
                if (substorage.Name.StartsWith("#"))
                {
                    // Skip paired transforms.
                    continue;
                }

                var mainTransform = substorage.Data;
                var mainWixFiles = new RowDictionary<WixFileRow>(mainTransform.Tables["WixFile"]);
                var mainMsiFileHashIndex = new RowDictionary<Row>(mainTransform.Tables["MsiFileHash"]);

                var mainFileTable = mainTransform.Tables["File"];
                var pairedTransform = pairedTransforms[substorage.Name];

                // copy Media.LastSequence and index the MsiFileHash table if it exists.
                if (copyFromPatch)
                {
                    var pairedMediaTable = pairedTransform.Tables["Media"];
                    foreach (MediaRow pairedMediaRow in pairedMediaTable.Rows)
                    {
                        var patchMediaRow = patchMediaRows.Get(pairedMediaRow.DiskId);
                        pairedMediaRow.Fields[1] = patchMediaRow.Fields[1];
                    }

                    if (null != mainMsiFileHashTable)
                    {
                        mainMsiFileHashIndex = new RowDictionary<Row>(mainMsiFileHashTable);
                    }

                    // Validate file row changes for keypath-related issues
                    this.ValidateFileRowChanges(mainTransform);
                }

                if (null == mainFileTable)
                {
                    continue;
                }

                // Index File table of pairedTransform
                var pairedFileRows = new RowDictionary<FileRow>(pairedTransform.Tables["File"]);

                foreach (FileRow mainFileRow in mainFileTable.Rows)
                {
                    if (RowOperation.Delete == mainFileRow.Operation)
                    {
                        continue;
                    }
                    else if (RowOperation.None == mainFileRow.Operation)
                    {
                        continue;
                    }

                    var mainWixFileRow = mainWixFiles.Get(mainFileRow.File);

                    if (copyToPatch) // when copying to the patch, we need compare the underlying files and include all file changes.
                    {
                        var objectField = (ObjectField)mainWixFileRow.Fields[6];
                        var pairedFileRow = pairedFileRows.Get(mainFileRow.File);

                        // If the file is new, we always need to add it to the patch.
                        if (mainFileRow.Operation != RowOperation.Add)
                        {
                            // If PreviousData doesn't exist, target and upgrade layout point to the same location. No need to compare.
                            if (null == objectField.PreviousData)
                            {
                                if (mainFileRow.Operation == RowOperation.None)
                                {
                                    continue;
                                }
                            }
                            else
                            {
                                // TODO: should this entire condition be placed in the binder file manager?
                                if ((0 == (PatchAttributeType.Ignore & mainWixFileRow.PatchAttributes)) &&
                                    !this.CompareFiles(objectField.PreviousData.ToString(), objectField.Data.ToString()))
                                {
                                    // If the file is different, we need to mark the mainFileRow and pairedFileRow as modified.
                                    mainFileRow.Operation = RowOperation.Modify;
                                    if (null != pairedFileRow)
                                    {
                                        // Always patch-added, but never non-compressed.
                                        pairedFileRow.Attributes |= WindowsInstallerConstants.MsidbFileAttributesPatchAdded;
                                        pairedFileRow.Attributes &= ~WindowsInstallerConstants.MsidbFileAttributesNoncompressed;
                                        pairedFileRow.Fields[6].Modified = true;
                                        pairedFileRow.Operation = RowOperation.Modify;
                                    }
                                }
                                else
                                {
                                    // The File is same. We need mark all the attributes as unchanged.
                                    mainFileRow.Operation = RowOperation.None;
                                    foreach (var field in mainFileRow.Fields)
                                    {
                                        field.Modified = false;
                                    }

                                    if (null != pairedFileRow)
                                    {
                                        pairedFileRow.Attributes &= ~WindowsInstallerConstants.MsidbFileAttributesPatchAdded;
                                        pairedFileRow.Fields[6].Modified = false;
                                        pairedFileRow.Operation = RowOperation.None;
                                    }
                                    continue;
                                }
                            }
                        }
                        else if (null != pairedFileRow) // RowOperation.Add
                        {
                            // Always patch-added, but never non-compressed.
                            pairedFileRow.Attributes |= WindowsInstallerConstants.MsidbFileAttributesPatchAdded;
                            pairedFileRow.Attributes &= ~WindowsInstallerConstants.MsidbFileAttributesNoncompressed;
                            pairedFileRow.Fields[6].Modified = true;
                            pairedFileRow.Operation = RowOperation.Add;
                        }
                    }

                    // index patch files by diskId+fileId
                    int diskId = mainWixFileRow.DiskId;

                    if (!patchMediaFileRows.TryGetValue(diskId, out var mediaFileRows))
                    {
                        mediaFileRows = new RowDictionary<WixFileRow>();
                        patchMediaFileRows.Add(diskId, mediaFileRows);
                    }

                    var fileId = mainFileRow.File;
                    var patchFileRow = mediaFileRows.Get(fileId);
                    if (copyToPatch)
                    {
                        if (null == patchFileRow)
                        {
                            var patchActualFileRow = (FileRow)patchFileTable.CreateRow(mainFileRow.SourceLineNumbers);
                            patchActualFileRow.CopyFrom(mainFileRow);

                            patchFileRow = (WixFileRow)patchFileTable.CreateRow(mainFileRow.SourceLineNumbers);
                            patchFileRow.CopyFrom(mainWixFileRow);

                            mediaFileRows.Add(patchFileRow);

                            allFileRows.Add(new FileFacade(patchActualFileRow, patchFileRow, null)); // TODO: should we be passing along delta information? Probably, right?
                        }
                        else
                        {
                            // TODO: confirm the rest of data is identical?

                            // make sure Source is same. Otherwise we are silently ignoring a file.
                            if (0 != String.Compare(patchFileRow.Source, mainWixFileRow.Source, StringComparison.OrdinalIgnoreCase))
                            {
                                this.Messaging.Write(ErrorMessages.SameFileIdDifferentSource(mainFileRow.SourceLineNumbers, fileId, patchFileRow.Source, mainWixFileRow.Source));
                            }

                            // capture the previous file versions (and associated data) from this targeted instance of the baseline into the current filerow.
                            patchFileRow.AppendPreviousDataFrom(mainWixFileRow);
                        }
                    }
                    //else
                    //{
                    //    // copy data from the patch back to the transform
                    //    if (null != patchFileRow)
                    //    {
                    //        var pairedFileRow = pairedFileRows.Get(fileId);
                    //        for (var i = 0; i < patchFileRow.Fields.Length; i++)
                    //        {
                    //            var patchValue = patchFileRow[i] == null ? String.Empty : patchFileRow.FieldAsString(i);
                    //            var mainValue = mainFileRow[i] == null ? String.Empty : mainFileRow.FieldAsString(i);

                    //            if (1 == i)
                    //            {
                    //                // File.Component_ changes should not come from the shared file rows
                    //                // that contain the file information as each individual transform might
                    //                // have different changes (or no changes at all).
                    //            }
                    //            // File.Attributes should not changed for binary deltas
                    //            else if (6 == i)
                    //            {
                    //                if (null != patchFileRow.Patch)
                    //                {
                    //                    // File.Attribute should not change for binary deltas
                    //                    pairedFileRow.Attributes = mainFileRow.Attributes;
                    //                    mainFileRow.Fields[i].Modified = false;
                    //                }
                    //            }
                    //            // File.Sequence is updated in pairedTransform, not mainTransform
                    //            else if (7 == i)
                    //            {
                    //                // file sequence is updated in Patch table instead of File table for delta patches
                    //                if (null != patchFileRow.Patch)
                    //                {
                    //                    pairedFileRow.Fields[i].Modified = false;
                    //                }
                    //                else
                    //                {
                    //                    pairedFileRow[i] = patchFileRow[i];
                    //                    pairedFileRow.Fields[i].Modified = true;
                    //                }
                    //                mainFileRow.Fields[i].Modified = false;
                    //            }
                    //            else if (patchValue != mainValue)
                    //            {
                    //                mainFileRow[i] = patchFileRow[i];
                    //                mainFileRow.Fields[i].Modified = true;
                    //                if (mainFileRow.Operation == RowOperation.None)
                    //                {
                    //                    mainFileRow.Operation = RowOperation.Modify;
                    //                }
                    //            }
                    //        }

                    //        // copy MsiFileHash row for this File
                    //        if (!mainMsiFileHashIndex.TryGetValue(patchFileRow.File, out var patchHashRow))
                    //        {
                    //            patchHashRow = patchFileRow.Hash;
                    //        }

                    //        if (null != patchHashRow)
                    //        {
                    //            var mainHashTable = mainTransform.EnsureTable(this.TableDefinitions["MsiFileHash"]);
                    //            var mainHashRow = mainHashTable.CreateRow(mainFileRow.SourceLineNumbers);
                    //            for (var i = 0; i < patchHashRow.Fields.Length; i++)
                    //            {
                    //                mainHashRow[i] = patchHashRow[i];
                    //                if (i > 1)
                    //                {
                    //                    // assume all hash fields have been modified
                    //                    mainHashRow.Fields[i].Modified = true;
                    //                }
                    //            }

                    //            // assume the MsiFileHash operation follows the File one
                    //            mainHashRow.Operation = mainFileRow.Operation;
                    //        }

                    //        // copy MsiAssemblyName rows for this File
                    //        List<Row> patchAssemblyNameRows = patchFileRow.AssemblyNames;
                    //        if (null != patchAssemblyNameRows)
                    //        {
                    //            var mainAssemblyNameTable = mainTransform.EnsureTable(this.TableDefinitions["MsiAssemblyName"]);
                    //            foreach (var patchAssemblyNameRow in patchAssemblyNameRows)
                    //            {
                    //                // Copy if there isn't an identical modified/added row already in the transform.
                    //                var foundMatchingModifiedRow = false;
                    //                foreach (var mainAssemblyNameRow in mainAssemblyNameTable.Rows)
                    //                {
                    //                    if (RowOperation.None != mainAssemblyNameRow.Operation && mainAssemblyNameRow.GetPrimaryKey('/').Equals(patchAssemblyNameRow.GetPrimaryKey('/')))
                    //                    {
                    //                        foundMatchingModifiedRow = true;
                    //                        break;
                    //                    }
                    //                }

                    //                if (!foundMatchingModifiedRow)
                    //                {
                    //                    var mainAssemblyNameRow = mainAssemblyNameTable.CreateRow(mainFileRow.SourceLineNumbers);
                    //                    for (var i = 0; i < patchAssemblyNameRow.Fields.Length; i++)
                    //                    {
                    //                        mainAssemblyNameRow[i] = patchAssemblyNameRow[i];
                    //                    }

                    //                    // assume value field has been modified
                    //                    mainAssemblyNameRow.Fields[2].Modified = true;
                    //                    mainAssemblyNameRow.Operation = mainFileRow.Operation;
                    //                }
                    //            }
                    //        }

                    //        // Add patch header for this file
                    //        if (null != patchFileRow.Patch)
                    //        {
                    //            // Add the PatchFiles action automatically to the AdminExecuteSequence and InstallExecuteSequence tables.
                    //            this.AddPatchFilesActionToSequenceTable(SequenceTable.AdminExecuteSequence, mainTransform, pairedTransform, mainFileRow);
                    //            this.AddPatchFilesActionToSequenceTable(SequenceTable.InstallExecuteSequence, mainTransform, pairedTransform, mainFileRow);

                    //            // Add to Patch table
                    //            var patchTable = pairedTransform.EnsureTable(this.TableDefinitions["Patch"]);
                    //            if (0 == patchTable.Rows.Count)
                    //            {
                    //                patchTable.Operation = TableOperation.Add;
                    //            }

                    //            var patchRow = patchTable.CreateRow(mainFileRow.SourceLineNumbers);
                    //            patchRow[0] = patchFileRow.File;
                    //            patchRow[1] = patchFileRow.Sequence;

                    //            var patchFile = new FileInfo(patchFileRow.Source);
                    //            patchRow[2] = (int)patchFile.Length;
                    //            patchRow[3] = 0 == (PatchAttributeType.AllowIgnoreOnError & patchFileRow.PatchAttributes) ? 0 : 1;

                    //            var streamName = patchTable.Name + "." + patchRow[0] + "." + patchRow[1];
                    //            if (Msi.MsiInterop.MsiMaxStreamNameLength < streamName.Length)
                    //            {
                    //                streamName = "_" + Guid.NewGuid().ToString("D").ToUpperInvariant().Replace('-', '_');

                    //                var patchHeadersTable = pairedTransform.EnsureTable(this.TableDefinitions["MsiPatchHeaders"]);
                    //                if (0 == patchHeadersTable.Rows.Count)
                    //                {
                    //                    patchHeadersTable.Operation = TableOperation.Add;
                    //                }

                    //                var patchHeadersRow = patchHeadersTable.CreateRow(mainFileRow.SourceLineNumbers);
                    //                patchHeadersRow[0] = streamName;
                    //                patchHeadersRow[1] = patchFileRow.Patch;
                    //                patchRow[5] = streamName;
                    //                patchHeadersRow.Operation = RowOperation.Add;
                    //            }
                    //            else
                    //            {
                    //                patchRow[4] = patchFileRow.Patch;
                    //            }
                    //            patchRow.Operation = RowOperation.Add;
                    //        }
                    //    }
                    //    else
                    //    {
                    //        // TODO: throw because all transform rows should have made it into the patch
                    //    }
                    //}
                }
            }
#endif
            this.FileFacades = allFileRows;
        }

        /// <summary>
        /// Adds the PatchFiles action to the sequence table if it does not already exist.
        /// </summary>
        /// <param name="table">The sequence table to check or modify.</param>
        /// <param name="mainTransform">The primary authoring transform.</param>
        /// <param name="pairedTransform">The secondary patch transform.</param>
        /// <param name="mainFileRow">The file row that contains information about the patched file.</param>
        private void AddPatchFilesActionToSequenceTable(SequenceTable table, WindowsInstallerData mainTransform, WindowsInstallerData pairedTransform, Row mainFileRow)
        {
            var tableName = table.ToString();

            // Find/add PatchFiles action (also determine sequence for it).
            // Search mainTransform first, then pairedTransform (pairedTransform overrides).
            var hasPatchFilesAction = false;
            var installFilesSequence = 0;
            var duplicateFilesSequence = 0;

            TestSequenceTableForPatchFilesAction(
                    mainTransform.Tables[tableName],
                    ref hasPatchFilesAction,
                    ref installFilesSequence,
                    ref duplicateFilesSequence);
            TestSequenceTableForPatchFilesAction(
                    pairedTransform.Tables[tableName],
                    ref hasPatchFilesAction,
                    ref installFilesSequence,
                    ref duplicateFilesSequence);
            if (!hasPatchFilesAction)
            {
                WindowsInstallerStandard.TryGetStandardAction(tableName, "PatchFiles", out var patchFilesActionTuple);

                var sequence = patchFilesActionTuple.Sequence;

                // Test for default sequence value's appropriateness
                if (installFilesSequence >= sequence || (0 != duplicateFilesSequence && duplicateFilesSequence <= sequence))
                {
                    if (0 != duplicateFilesSequence)
                    {
                        if (duplicateFilesSequence < installFilesSequence)
                        {
                            throw new WixException(ErrorMessages.InsertInvalidSequenceActionOrder(mainFileRow.SourceLineNumbers, tableName, "InstallFiles", "DuplicateFiles", patchFilesActionTuple.Action));
                        }
                        else
                        {
                            sequence = (duplicateFilesSequence + installFilesSequence) / 2;
                            if (installFilesSequence == sequence || duplicateFilesSequence == sequence)
                            {
                                throw new WixException(ErrorMessages.InsertSequenceNoSpace(mainFileRow.SourceLineNumbers, tableName, "InstallFiles", "DuplicateFiles", patchFilesActionTuple.Action));
                            }
                        }
                    }
                    else
                    {
                        sequence = installFilesSequence + 1;
                    }
                }

                var sequenceTable = pairedTransform.EnsureTable(this.TableDefinitions[tableName]);
                if (0 == sequenceTable.Rows.Count)
                {
                    sequenceTable.Operation = TableOperation.Add;
                }

                var patchAction = sequenceTable.CreateRow(null);
                patchAction[0] = patchFilesActionTuple.Action;
                patchAction[1] = patchFilesActionTuple.Condition;
                patchAction[2] = sequence;
                patchAction.Operation = RowOperation.Add;
            }
        }

        /// <summary>
        /// Tests sequence table for PatchFiles and associated actions
        /// </summary>
        /// <param name="sequenceTable">The table to test.</param>
        /// <param name="hasPatchFilesAction">Set to true if PatchFiles action is found. Left unchanged otherwise.</param>
        /// <param name="installFilesSequence">Set to sequence value of InstallFiles action if found. Left unchanged otherwise.</param>
        /// <param name="duplicateFilesSequence">Set to sequence value of DuplicateFiles action if found. Left unchanged otherwise.</param>
        private static void TestSequenceTableForPatchFilesAction(Table sequenceTable, ref bool hasPatchFilesAction, ref int installFilesSequence, ref int duplicateFilesSequence)
        {
            if (null != sequenceTable)
            {
                foreach (var row in sequenceTable.Rows)
                {
                    var actionName = row.FieldAsString(0);
                    switch (actionName)
                    {
                        case "PatchFiles":
                            hasPatchFilesAction = true;
                            break;

                        case "InstallFiles":
                            installFilesSequence = row.FieldAsInteger(2);
                            break;

                        case "DuplicateFiles":
                            duplicateFilesSequence = row.FieldAsInteger(2);
                            break;
                    }
                }
            }
        }

        /// <summary>
        /// Signal a warning if a non-keypath file was changed in a patch without also changing the keypath file of the component.
        /// </summary>
        /// <param name="output">The output to validate.</param>
        private void ValidateFileRowChanges(WindowsInstallerData transform)
        {
            var componentTable = transform.Tables["Component"];
            var fileTable = transform.Tables["File"];

            // There's no sense validating keypaths if the transform has no component or file table
            if (componentTable == null || fileTable == null)
            {
                return;
            }

            var componentKeyPath = new Dictionary<string, string>(componentTable.Rows.Count);

            // Index the Component table for non-directory & non-registry key paths.
            foreach (var row in componentTable.Rows)
            {
                var keyPath = row.FieldAsString(5);
                if (keyPath != null && 0 != (row.FieldAsInteger(3) & WindowsInstallerConstants.MsidbComponentAttributesRegistryKeyPath))
                {
                    componentKeyPath.Add(row.FieldAsString(0), keyPath);
                }
            }

            var componentWithChangedKeyPath = new Dictionary<string, string>();
            var componentWithNonKeyPathChanged = new Dictionary<string, string>();
            // Verify changes in the file table, now that file diffing has occurred
            foreach (FileRow row in fileTable.Rows)
            {
                if (RowOperation.Modify != row.Operation)
                {
                    continue;
                }

                var fileId = row.FieldAsString(0);
                var componentId = row.FieldAsString(1);

                // If this file is the keypath of a component
                if (componentKeyPath.ContainsValue(fileId))
                {
                    if (!componentWithChangedKeyPath.ContainsKey(componentId))
                    {
                        componentWithChangedKeyPath.Add(componentId, fileId);
                    }
                }
                else
                {
                    if (!componentWithNonKeyPathChanged.ContainsKey(componentId))
                    {
                        componentWithNonKeyPathChanged.Add(componentId, fileId);
                    }
                }
            }

            foreach (var componentFile in componentWithNonKeyPathChanged)
            {
                // Make sure all changes to non keypath files also had a change in the keypath.
                if (!componentWithChangedKeyPath.ContainsKey(componentFile.Key) && componentKeyPath.TryGetValue(componentFile.Key, out var keyPath))
                {
                    this.Messaging.Write(WarningMessages.UpdateOfNonKeyPathFile(componentFile.Value, componentFile.Key, keyPath));
                }
            }
        }

        private bool CompareFiles(string targetFile, string updatedFile)
        {
            bool? compared = null;
            foreach (var extension in this.Extensions)
            {
                compared = extension.CompareFiles(targetFile, updatedFile);

                if (compared.HasValue)
                {
                    break;
                }
            }

            if (!compared.HasValue)
            {
                throw new InvalidOperationException(); // TODO: something needs to be said here that none of the binder file managers returned a result.
            }

            return compared.Value;
        }
    }
}