/*
    Copyright 2020 Katy Coe - http://www.djkaty.com - https://github.com/djkaty

    All rights reserved.
*/

using System;
using System.Collections.Generic;
using System.Linq;

namespace Il2CppInspector
{
    // Some IL2CPP applications obfuscate the order of fields in Il2CppCodeRegistration and Il2CppMetadataRegistration
    // specifically to defeat IL2CPP reverse engineering tools. We make an imperfect attempt to defeat this below
    // by re-arranging the fields back into their original order. This can be greatly improved and much more deeply analyzed.
    // Devs: Please don't burn development resources on obfuscation. It's a waste of your time and mine. Spend it making good games instead.
    partial class Il2CppBinary
    {
        // Loads all the pointers and counts for the specified IL2CPP metadata type regardless of version or word size into two arrays
        // Sorts the pointers and calculates the maximum number of words between each, constrained by the highest count in the IL2CPP metadata type
        // and by the end of the nearest section in the image.
        // Returns an array of the pointers in sorted order and an array of maximum word counts with corresponding indexes
        private (List<ulong> ptrs, List<int> counts) preparePointerList(Type type, ulong typePtr, IEnumerable<Section> sections) {
            // Get number of pointer/count pairs in each structure
            var itemsCount = Metadata.Sizeof(type, Image.Version, Image.Bits / 8) / (Image.Bits / 8) / 2;

            // Read pointers and counts as two lists
            var itemArray = Image.ReadMappedArray<ulong>(typePtr, itemsCount * 2);
            var itemPtrs = Enumerable.Range(0, itemArray.Length / 2).Select(i => itemArray[i*2 + 1]).ToList();
            var itemCounts = Enumerable.Range(0, itemArray.Length / 2).Select(i => (int) itemArray[i*2]).ToList();

            // Get maximum count between each pair of pointers
            // None of the maximums should be higher than the maximum count specified in the struct
            // Rule out zero pointers for no longer used fields (eg. customAttributeGenerators >=27)
            var itemMaxCount = itemCounts.Max();
            var itemPtrsOrdered = itemPtrs.Where(p => p != 0).OrderBy(p => p).ToList();
            var itemCountLimits = itemPtrsOrdered
                                    .Zip(itemPtrsOrdered.Skip(1), (a, b) => Math.Min((int) (b - a) / (Image.Bits / 8), itemMaxCount))
                                    .Append(itemMaxCount)
                                    .ToList();

            // Prevent a pointer list from overrunning the end of a section
            for (var i = 0; i < itemPtrsOrdered.Count; i++) {
                var section = sections.FirstOrDefault(s => s.VirtualStart <= itemPtrsOrdered[i] && s.VirtualEnd >= itemPtrsOrdered[i]);
                if (section != null) {
                    var maxSize = (int) (section.VirtualEnd + 1 - itemPtrsOrdered[i]) / (Image.Bits / 8);
                    itemCountLimits[i] = Math.Min(itemCountLimits[i], maxSize);
                }
            }

            return (itemPtrsOrdered, itemCountLimits);
        }

        // Reconstruct Il2CppCodeRegistration and Il2CppMetadataRegistration into their original, unobfuscated field order
        private void ReconstructMetadata(Metadata metadata) {
            // If the section table is not available, give up and do nothing
            if (!Image.TryGetSections(out var sections))
                return;

            // Get relevant image sections
            var codeSections = sections.Where(s => s.IsExec);
            var dataSections = sections.Where(s => s.IsData);

            // Fetch and sanitize our pointer and count lists
            var (codePtrsOrdered, codeCountLimits) = preparePointerList(typeof(Il2CppCodeRegistration), CodeRegistrationPointer, dataSections);
            var (metaPtrsOrdered, metaCountLimits) = preparePointerList(typeof(Il2CppMetadataRegistration), MetadataRegistrationPointer, dataSections);

            // Some heuristic constants

            // Counts from minimal compiles

            // v21 test project:
            // genericMethodPointers - 0x07B5, customAttributeGenerators - 0x0747, invokerPointers - 0x04DB, methodPointers - 0x226A
            // v24.1 empty Unity project:
            // genericMethodPointers - 0x0C15, customAttributeGenerators - 0x0A21, invokerPointers - 0x0646, methodPointers - 0x268B
            // v24.2 without Unity:
            // genericMethodPointers - 0x2EC2, customAttributeGenerators - 0x15EC, invokerPointers - 0x0B65

            // v21 test project:
            // genericInsts - 0x0150, genericMethodTable - 0x0805, types - 0x1509, methodSpecs - 0x08D8, fieldOffsets - 0x0569, metadataUsages - 0x1370
            // v24.1 empty Unity project:
            // genericInsts - 0x025E, genericMethodTable - 0x0E3F, types - 0x2632, methodSpecs - 0x0FD4, fieldOffsets - 0x0839, metadataUsages - 0x1850
            // v24.2 without Unity:
            // genericInsts - 0x06D4, genericMethodTable - 0x31E8, types - 0x318A, methodSpecs - 0x3AD8, fieldOffsets - 0x0B3D, metadataUsages - 0x3BA8

            // The maximum address gap in a sequential list of pointers before the sequence is considered to be 'broken'
            const int MAX_SEQUENCE_GAP = 0x10000;

            // The minimum number of Il2CppTypes we expect
            const int MIN_TYPES = 0x1400;

            // The maximum number of generic type parameters we expect for any class or method
            const int MAX_GENERIC_TYPE_PARAMETERS = 32;

            // The minimum number of Il2CppGenericInsts we expect
            const int MIN_GENERIC_INSTANCES = 0x140;

            // The maximum number of generic methods in generic classes we expect to find in a single sequence of Il2CppMethodSpec
            // The highest we have seen in a production app is 3414; the next highest 2013, the next highest 1380
            // 300-600 is typical
            const int MAX_SEQUENTIAL_GENERIC_CLASS_METHODS = 5000;

            // The minimum number of Il2CppMethodSpecs we expect
            const int MIN_METHOD_SPECS = 0x0800;

            // Things we need from Il2CppCodeRegistration

            // methodPointers (<=24.1)         -> list of function pointers (1st count) (non-sequential)
            // genericMethodPointers           -> list of function pointers (first IS zero) (2nd count) (not sequential)
            // customAttributeGenerators (<27) -> list of function pointers (first MAY be zero) (2nd count) (sequential)
            // invokerPointers                 -> list of function pointers (3rd count) (sequential)
            // codeGenModules (>=24.2)         -> list of Il2CppCodeGenModule* // TODO: We only support <=24.1 currently
            // (interopData will probably have 6 sequential pointers since Il2CppInteropData starts with 5 function pointers and a GUID)

            // Let's see how many valid pointers and sequential valid pointers we actually find at each address
            // Scan each pointer address for valid list of function pointers and sort into size order
            // Consider the sequence to be broken if there is a gap over a certain threshold
            var fnPtrs = new SortedDictionary<ulong, int>();
            var seqFnPtrs = new SortedDictionary<ulong, int>();
            for (var i = 0; i < codePtrsOrdered.Count; i++) {

                // Non-sequential valid pointers
                var ptrs = Image.ReadMappedArray<ulong>(codePtrsOrdered[i], codeCountLimits[i]);
                var foundCount = ptrs.TakeWhile(p => codeSections.Any(s => p >= s.VirtualStart && p <= s.VirtualEnd || p == 0)).Count();

                // Prune count of trailing zero pointers
                while (foundCount > 0 && ptrs[foundCount - 1] == 0ul)
                    foundCount--;

                fnPtrs.Add(codePtrsOrdered[i], foundCount);

                // Binaries compiled with MSVC (generally PE files) use /OPT:ICF by default (enable ICF) so this won't work.
                // For these binaries, we'll use a different selection strategy below
                if (Image is PEReader)
                    continue;

                // Sequential valid pointers (a subset of non-sequential valid pointers)
                foundCount = ptrs.Take(foundCount)
                    .Zip(ptrs.Take(foundCount).Skip(1), (a, b) => (a, b))
                    .TakeWhile(t => ((long) t.b - (long) t.a >= 0 || t.b == 0)
                                    && ((long) t.b - (long) t.a < MAX_SEQUENCE_GAP || t.a == 0)
                                    // Disallow two zero pointers in a row
                                    && (t.a != 0 || t.b != 0))
                    .Count() + 1;

                // Prune count of trailing zero pointers
                while (foundCount > 0 && ptrs[foundCount - 1] == 0ul)
                    foundCount--;

                seqFnPtrs.Add(codePtrsOrdered[i], foundCount);
            }

            KeyValuePair<ulong, int> methodPointers, genericMethodPointers, customAttributeGenerators, invokerPointers;

            // Solution without ICF
            if (!(Image is PEReader)) {
                // The two largest sequential groups are customAttributeGenerators and invokerPointers
                var seqLongest = seqFnPtrs.OrderByDescending(kv => kv.Value).Take(2).ToList();
                (customAttributeGenerators, invokerPointers) = (seqLongest[0], seqLongest[1]);

                // For >=27, customAttributeGenerators is zero and so the largest group is invokerPointers
                if (Image.Version >= 27) {
                    invokerPointers = customAttributeGenerators;
                    customAttributeGenerators = new KeyValuePair<ulong, int>(0ul, 0);
                }

                // After removing these from the non-sequential list, the largest groups are methodPointers and genericMethodPointers
                var longest = fnPtrs.Except(seqLongest).OrderByDescending(kv => kv.Value).Take(2).ToList();
                (methodPointers, genericMethodPointers) = (longest[0], longest[1]);

                // For >=24.2, methodPointers is zero and so the largest group is genericMethodPointers
                if (Image.Version >= 24.2) {
                    genericMethodPointers = methodPointers;
                    methodPointers = new KeyValuePair<ulong, int>(0ul, 0);
                }

                // Prune genericMethodPointers at 2nd zero (first pointer is always zero)
                var gmPtr = Image.ReadMappedArray<ulong>(genericMethodPointers.Key, genericMethodPointers.Value);
                var gmZero = Array.IndexOf(gmPtr, 0ul, 1);
                if (gmZero != -1)
                    genericMethodPointers = new KeyValuePair<ulong, int>(genericMethodPointers.Key, gmZero);
            }

            // Solution with ICF
            else {
                // Take and remove the first item and assume it's methodPointers for <=24.1, otherwise set to zero
                var orderedPtrs = fnPtrs.OrderByDescending(kv => kv.Value).ToList();
                if (Image.Version <= 24.1) {
                    methodPointers = orderedPtrs[0];
                    orderedPtrs.RemoveAt(0);
                } else
                    methodPointers = new KeyValuePair<ulong, int>(0ul, 0);

                // Assume this order is right most of the time
                // TODO: generic and custom attribute might be the wrong way round (eg. #102)
                (genericMethodPointers, customAttributeGenerators, invokerPointers) = (orderedPtrs[0], orderedPtrs[1], orderedPtrs[2]);

                // customAttributeGenerators is removed in metadata >=27
                if (Image.Version >= 27) {
                    invokerPointers = customAttributeGenerators;
                    customAttributeGenerators = new KeyValuePair<ulong, int>(0ul, 0);
                }
            }

            #region Debugging validation checks
            #if DEBUG
            // Used on non-obfuscated binaries during development to confirm the output is correct
            if (methodPointers.Key != CodeRegistration.pmethodPointers)
                throw new Exception("Method Pointers incorrect");
            if (invokerPointers.Key != CodeRegistration.invokerPointers)
                throw new Exception("Invoker Pointers incorrect");
            if (customAttributeGenerators.Key != CodeRegistration.customAttributeGenerators)
                throw new Exception("Custom attribute generators incorrect");
            if (genericMethodPointers.Key != CodeRegistration.genericMethodPointers)
                throw new Exception("Generic method pointers incorrect");

            if (methodPointers.Value != (int) CodeRegistration.methodPointersCount)
                throw new Exception("Count of Method Pointers incorrect");
            if (invokerPointers.Value != (int) CodeRegistration.invokerPointersCount)
                throw new Exception("Count of Invoker Pointers incorrect");
            if (customAttributeGenerators.Value != (int) CodeRegistration.customAttributeCount)
                throw new Exception("Count of Custom attribute generators incorrect");
            if (genericMethodPointers.Value != (int) CodeRegistration.genericMethodPointersCount)
                throw new Exception("Count of Generic method pointers incorrect");
            #endif
            #endregion

            // Perform substitution
            CodeRegistration.genericMethodPointers      = genericMethodPointers.Key;
            CodeRegistration.genericMethodPointersCount = (ulong) genericMethodPointers.Value;
            CodeRegistration.customAttributeGenerators  = customAttributeGenerators.Key;
            CodeRegistration.customAttributeCount       = customAttributeGenerators.Value;
            CodeRegistration.invokerPointers            = invokerPointers.Key;
            CodeRegistration.invokerPointersCount       = (ulong) invokerPointers.Value;
            CodeRegistration.pmethodPointers            = methodPointers.Key;
            CodeRegistration.methodPointersCount        = (ulong) methodPointers.Value;

            // Force CodeRegistration to pass validation in Il2CppBinary.Configure()
            CodeRegistration.reversePInvokeWrapperCount = 0;
            CodeRegistration.unresolvedVirtualCallCount = 0;
            CodeRegistration.interopDataCount           = 0;

            // Things we need from Il2CppMetadataRegistration

            // genericInsts               -> list of Il2CppGenericInst* (argc is count of Il2CppType* at data pointer argv; datapoint = GenericParameterIndex)
            // genericMethodTable         -> list of Il2CppGenericMethodFunctionsDefinitions (genericMethodIndex, methodIndex, invokerIndex)
            // types                      -> list of Il2CppType*
            // methodSpecs                -> list of Il2CppMethodSpec
            // methodReferences (<=16)    -> list of uint
            // fieldOffsets (fieldOffsetsArePointers) -> either a list of data pointers (some zero, some VAs not mappable) to list of uints, or a list of uints
            // metadataUsages (>=19, <27) -> list of unmappable data pointers

            // We can only perform this re-ordering if we can refer to a loaded global-metadata.dat
            if (metadata == null)
                return;

            // Read in all the required data once since we'll be using nested loops
            var metaPtrData = new List<(ulong, int, ulong[], ulong[], int, int, int)>();

            for (var i = 0; i < metaPtrsOrdered.Count; i++) {
                // Pointers in this list
                var ptrs = Image.ReadMappedArray<ulong>(metaPtrsOrdered[i], metaCountLimits[i]);

                // foundCount and foundMappableCount will generally be the same below
                // except in PE files where data and bss can overlap in our interpretation of the sections

                // First set of pointers that point to a data section virtual address
                var foundCount = ptrs.TakeWhile(p => dataSections.Any(s => p >= s.VirtualStart && p <= s.VirtualEnd)).Count();

                // First set of pointers that can be mapped anywhere into the image
                var foundMappableCount = ptrs.TakeWhile(p => Image.TryMapVATR(p, out _)).Count();

                // First set of pointers that can be mapped into a data section in the image
                var ptrsMappableData = ptrs.Take(foundMappableCount)
                        .TakeWhile(p => dataSections.Any(s => Image.MapVATR(p) >= s.ImageStart && Image.MapVATR(p) <= s.ImageEnd))
                        .ToArray();

                var foundMappableDataCount = ptrsMappableData.Length;

                metaPtrData.Add((metaPtrsOrdered[i], metaCountLimits[i], ptrs, ptrsMappableData, foundCount, foundMappableCount, foundMappableDataCount));
            }

            // Items we need to search for
            var types =        (ptr: 0ul, count: -1);
            var genericInsts = (ptr: 0ul, count: -1);
            var methodSpecs  = (ptr: 0ul, count: -1);

            // Intermediary items
            var typesData = new Dictionary<ulong, Il2CppType>();
            var genericInstsCount = 0;
            var methodSpecsCount = 0;

            // Determine what each pointer is
            // We need to do this in a certain order because validating some items relies on earlier items
            while (metaPtrData.Any()) {

                var foundTarget = 0ul;

                // We loop repeatedly through every set of data looking for our next target item,
                // remove the matching set from the list and then repeat the outer while loop
                // until there is nothing left to find
                foreach (var (ptr, limit, ptrs, ptrsMappableData, foundCount, foundMappableCount, foundMappableDataCount) in metaPtrData) {

                    // Test for Il2CppType**
                    // ---------------------
                    if (types.ptr == 0) {

                        // We don't ever expect there to be less than MIN_TYPES types
                        if (foundMappableDataCount >= MIN_TYPES) {

                            // This statement is quite slow. We could speed it up with a two-stage approach
                            var testItems = Image.ReadMappedObjectPointerArray<Il2CppType>(ptr, foundMappableDataCount);
                            var foundItems = 0;

                            foreach (var item in testItems) {
                                // TODO: v27 will fail this because of the bit shifting in Il2CppType.bits
                                if (item.num_mods != 0)
                                    break;
                                if (!Enum.IsDefined(typeof(Il2CppTypeEnum), item.type))
                                    break;
                                if (item.type == Il2CppTypeEnum.IL2CPP_TYPE_END)
                                    break;

                                // Test datapoint
                                if (item.type switch {
                                    var t when (t is Il2CppTypeEnum.IL2CPP_TYPE_VALUETYPE || t is Il2CppTypeEnum.IL2CPP_TYPE_CLASS)
                                                && item.datapoint >= (ulong) metadata.Types.Length => false,

                                    var t when (t is Il2CppTypeEnum.IL2CPP_TYPE_VAR || t is Il2CppTypeEnum.IL2CPP_TYPE_MVAR)
                                                && item.datapoint >= (ulong) metadata.GenericParameters.Length => false,

                                    var t when (t is Il2CppTypeEnum.IL2CPP_TYPE_PTR || t is Il2CppTypeEnum.IL2CPP_TYPE_SZARRAY)
                                                && !ptrsMappableData.Contains(item.datapoint) => false,

                                    // Untested cases, we could add more here (IL2CPP_TYPE_ARRAY, IL2CPP_TYPE_GENERICINST)
                                    _ => true
                                })
                                    foundItems++;
                                else
                                    break;
                            }
                            if (foundItems >= MIN_TYPES) {
                                types = (ptr, foundItems);
                                typesData = ptrs.Take(foundItems)
                                            .Zip(testItems.Take(foundItems),(p, t) => (Ptr: p, Type: t))
                                            .ToDictionary(kv => kv.Ptr, kv => kv.Type);
                                foundTarget = ptr;
                                break;
                            }
                        }
                    }

                    // Test for Il2CppGenericInst**
                    // ----------------------------
                    else if (genericInsts.ptr == 0) {
                        var testItems = Image.ReadMappedObjectPointerArray<Il2CppGenericInst>(ptr, foundMappableDataCount);
                        var foundItems = 0;

                        foreach (var item in testItems) {
                            // Let's pray no generic type has more than this many type parameters
                            if (item.type_argc > MAX_GENERIC_TYPE_PARAMETERS)
                                break;

                            // All the generic type paramters must be in the total list of types,
                            // ie. typePtrs must be a subset of typesData.Keys
                            try {
                                var typePtrs = Image.ReadMappedArray<ulong>(item.type_argv, (int) item.type_argc);
                                if (typePtrs.Except(typesData.Keys).Any())
                                    break;
                            // Pointers were invalid
                            } catch (InvalidOperationException) {
                                break;
                            }

                            foundItems++;
                        }
                        if (foundItems >= MIN_GENERIC_INSTANCES) {
                            genericInsts = (ptr, foundItems);
                            genericInstsCount = foundItems;
                            foundTarget = ptr;
                            break;
                        }
                    }

                    // Test for Il2CppMethodSpec*
                    // --------------------------
                    else if (methodSpecs.ptr == 0) {
                        var max = Math.Max(limit * (Image.Bits / 8) / metadata.Sizeof(typeof(Il2CppMethodSpec)), limit);
                        var testItems = Image.ReadMappedArray<Il2CppMethodSpec>(ptr, max);
                        var foundItems = 0;
                        var nonNegativePairs = 0;

                        foreach (var item in testItems) {
                            if (item.methodDefinitionIndex < 0 || item.methodDefinitionIndex >= metadata.Methods.Length)
                                break;
                            if (item.classIndexIndex < -1 || item.classIndexIndex >= genericInstsCount)
                                break;
                            if (item.methodIndexIndex < -1 || item.methodIndexIndex >= genericInstsCount)
                                break;

                            if (item.classIndexIndex != -1 && item.methodIndexIndex != -1)
                                nonNegativePairs++;
                            else
                                nonNegativePairs = 0;

                            if (nonNegativePairs > MAX_SEQUENTIAL_GENERIC_CLASS_METHODS)
                                break;
                            foundItems++;
                        }

                        // Assumes last methods are not generic methods in generic classes
                        foundItems -= nonNegativePairs;

                        if (foundItems >= MIN_METHOD_SPECS) {
                            methodSpecs = (ptr, foundItems);
                            methodSpecsCount = foundItems;
                            foundTarget = ptr;
                            break;
                        }
                    }
                }

                // Successfully found the item we were looking for; remove it from the list
                if (foundTarget != 0ul)
                    metaPtrData = metaPtrData.Where(m => foundTarget != m.Item1).ToList();

                // We didn't find anything - break to avoid an infinite loop
                else
                    break;
            }

            #region Debugging validation checks
            #if DEBUG
            // Used on non-obfuscated binaries during development to confirm the output is correct
            if (types.ptr != MetadataRegistration.ptypes)
                throw new Exception("Il2CppType** incorrect");
            if (genericInsts.ptr != MetadataRegistration.genericInsts)
                throw new Exception("Il2CppGenericInst** incorrect");
            if (methodSpecs.ptr != MetadataRegistration.methodSpecs)
                throw new Exception("Il2CppMethodSpec* incorrect");

            if (types.count != MetadataRegistration.typesCount)
                throw new Exception("Count of Il2CppType* incorrect");
            if (genericInsts.count != MetadataRegistration.genericInstsCount)
                throw new Exception("Count of Il2CppGenericInst* incorrect");
            // We might be slightly off here, allow some tolerance
            if (Math.Abs(methodSpecs.count - MetadataRegistration.methodSpecsCount) > 25)
                throw new Exception("Count of Il2CppMethodSpec incorrect");
            #endif
            #endregion

            // Perform substitution
            MetadataRegistration.ptypes                    = types.ptr;
            MetadataRegistration.typesCount                = types.count;
            MetadataRegistration.genericInsts              = genericInsts.ptr;
            MetadataRegistration.genericInstsCount         = genericInsts.count;
            MetadataRegistration.methodSpecs               = methodSpecs.ptr;
            MetadataRegistration.methodSpecsCount          = methodSpecs.count;

            // Force MetadataRegistration to pass validation in Il2CppBinary.Configure()
            MetadataRegistration.typeDefinitionsSizesCount = 0;
            MetadataRegistration.genericClassesCount       = MetadataRegistration.genericInstsCount + 1;
            MetadataRegistration.genericMethodTableCount   = MetadataRegistration.genericInstsCount + 1;
        }
    }
}