/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.catalina.tribes.util;

import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.List;
import java.util.StringTokenizer;

import org.apache.catalina.tribes.ChannelMessage;
import org.apache.catalina.tribes.Member;
import org.apache.catalina.tribes.UniqueId;
import org.apache.catalina.tribes.group.AbsoluteOrder;
import org.apache.catalina.tribes.membership.Membership;

/**
 * Utility class for array operations in the Tribes clustering framework.
 */
public class Arrays {
    /** Prevents instantiation. */
    private Arrays() {}

    /** String manager for this class. */
    protected static final StringManager sm = StringManager.getManager(Arrays.class);

    /**
     * Checks if a byte array contains a key at a given offset.
     *
     * @param source the source byte array
     * @param srcoffset the offset in the source array
     * @param key the key byte array to search for
     * @param keyoffset the offset in the key array
     * @param length the length of the data to compare
     * @return {@code true} if the key is found at the given offset
     */
    public static boolean contains(byte[] source, int srcoffset, byte[] key, int keyoffset, int length) {
        if (srcoffset < 0 || srcoffset >= source.length) {
            throw new ArrayIndexOutOfBoundsException(sm.getString("arrays.srcoffset.outOfBounds"));
        }
        if (keyoffset < 0 || keyoffset >= key.length) {
            throw new ArrayIndexOutOfBoundsException(sm.getString("arrays.keyoffset.outOfBounds"));
        }
        if (length < 0 || length > (key.length - keyoffset)) {
            throw new ArrayIndexOutOfBoundsException(sm.getString("arrays.length.outOfBounds"));
        }
        // we don't have enough data to validate it
        if (length > (source.length - srcoffset)) {
            return false;
        }
        boolean match = true;
        int pos = keyoffset;
        for (int i = srcoffset; match && i < srcoffset + length; i++) {
            match = (source[i] == key[pos++]);
        }
        return match;
    }

    /**
     * Converts a byte array to a string representation.
     *
     * @param data the byte array
     * @return the string representation
     */
    public static String toString(byte[] data) {
        return toString(data, 0, data != null ? data.length : 0);
    }

    /**
     * Converts a portion of a byte array to a string representation.
     *
     * @param data the byte array
     * @param offset the starting offset
     * @param length the number of elements
     * @return the string representation
     */
    public static String toString(byte[] data, int offset, int length) {
        return toString(data, offset, length, false);
    }

    /**
     * Converts a portion of a byte array to a string representation, optionally treating bytes as unsigned.
     *
     * @param data the byte array
     * @param offset the starting offset
     * @param length the number of elements
     * @param unsigned {@code true} to treat bytes as unsigned
     * @return the string representation
     */
    public static String toString(byte[] data, int offset, int length, boolean unsigned) {
        StringBuilder buf = new StringBuilder("{");
        if (data != null && length > 0) {
            int i = offset;
            if (unsigned) {
                buf.append(data[i++] & 0xff);
                for (; i < offset + length; i++) {
                    buf.append(", ").append(data[i] & 0xff);
                }
            } else {
                buf.append(data[i++]);
                for (; i < offset + length; i++) {
                    buf.append(", ").append(data[i]);
                }
            }
        }
        buf.append('}');
        return buf.toString();
    }

    /**
     * Converts an object array to a string representation.
     *
     * @param data the object array
     * @return the string representation
     */
    public static String toString(Object[] data) {
        return toString(data, 0, data != null ? data.length : 0);
    }

    /**
     * Converts a portion of an object array to a string representation.
     *
     * @param data the object array
     * @param offset the starting offset
     * @param length the number of elements
     * @return the string representation
     */
    public static String toString(Object[] data, int offset, int length) {
        StringBuilder buf = new StringBuilder("{");
        if (data != null && length > 0) {
            int i = offset;
            buf.append(data[i++]);
            for (; i < offset + length; i++) {
                buf.append(", ").append(data[i]);
            }
        }
        buf.append('}');
        return buf.toString();
    }

    /**
     * Converts a member array to a string of member names.
     *
     * @param data the member array
     * @return the string of member names
     */
    public static String toNameString(Member[] data) {
        return toNameString(data, 0, data != null ? data.length : 0);
    }

    /**
     * Converts a portion of a member array to a string of member names.
     *
     * @param data the member array
     * @param offset the starting offset
     * @param length the number of elements
     * @return the string of member names
     */
    public static String toNameString(Member[] data, int offset, int length) {
        StringBuilder buf = new StringBuilder("{");
        if (data != null && length > 0) {
            int i = offset;
            buf.append(data[i++].getName());
            for (; i < offset + length; i++) {
                buf.append(", ").append(data[i].getName());
            }
        }
        buf.append('}');
        return buf.toString();
    }

    /**
     * Sums all elements of an integer array.
     *
     * @param data the integer array
     * @return the sum of all elements
     */
    public static int add(int[] data) {
        int result = 0;
        for (int datum : data) {
            result += datum;
        }
        return result;
    }

    /**
     * Extracts a UniqueId from a ChannelMessage.
     *
     * @param msg the channel message
     * @return the unique ID
     */
    public static UniqueId getUniqudId(ChannelMessage msg) {
        return new UniqueId(msg.getUniqueId());
    }

    /**
     * Creates a UniqueId from a byte array.
     *
     * @param data the byte array
     * @return the unique ID
     */
    public static UniqueId getUniqudId(byte[] data) {
        return new UniqueId(data);
    }

    /**
     * Compares two byte arrays for equality.
     *
     * @param o1 the first byte array
     * @param o2 the second byte array
     * @return {@code true} if the arrays are equal
     */
    public static boolean equals(byte[] o1, byte[] o2) {
        return java.util.Arrays.equals(o1, o2);
    }

    /**
     * Compares two object arrays for equality.
     *
     * @param o1 the first object array
     * @param o2 the second object array
     * @return {@code true} if the arrays are equal
     */
    public static boolean equals(Object[] o1, Object[] o2) {
        return java.util.Arrays.equals(o1, o2);
    }

    /**
     * Checks if two member arrays contain the same members. Both arrays will
     * be mutated to be sorted.
     *
     * @param m1 the first member array
     * @param m2 the second member array
     * @return {@code true} if both arrays contain the same members
     */
    public static boolean sameMembers(Member[] m1, Member[] m2) {
        AbsoluteOrder.absoluteOrder(m1);
        AbsoluteOrder.absoluteOrder(m2);
        return equals(m1, m2);
    }

    /**
     * Merges two member arrays, removing duplicates. Both arrays will
     * be mutated to be sorted.
     *
     * @param m1 the first member array
     * @param m2 the second member array
     * @return the merged member array
     */
    public static Member[] merge(Member[] m1, Member[] m2) {
        AbsoluteOrder.absoluteOrder(m1);
        AbsoluteOrder.absoluteOrder(m2);
        ArrayList<Member> list = new ArrayList<>(java.util.Arrays.asList(m1));
        for (Member member : m2) {
            if (!list.contains(member)) {
                list.add(member);
            }
        }
        Member[] result = list.toArray(new Member[0]);
        AbsoluteOrder.absoluteOrder(result);
        return result;
    }

    /**
     * Adds all members from an array to a Membership.
     *
     * @param mbrship the membership to add members to
     * @param m the member array
     */
    public static void fill(Membership mbrship, Member[] m) {
        for (Member member : m) {
            mbrship.addMember(member);
        }
    }

    /**
     * Returns members in the complete set that are not in the local set.
     *
     * @param complete the complete membership
     * @param local the local membership
     * @param ignore the member to ignore
     * @return the difference as a member array
     */
    public static Member[] diff(Membership complete, Membership local, Member ignore) {
        List<Member> result = new ArrayList<>();
        Member[] comp = complete.getMembers();
        for (Member member : comp) {
            if (ignore != null && ignore.equals(member)) {
                continue;
            }
            if (local.getMember(member) == null) {
                result.add(member);
            }
        }
        return result.toArray(new Member[0]);
    }

    /**
     * Removes a single member from an array.
     *
     * @param all the member array
     * @param remove the member to remove
     * @return the array with the member removed
     */
    public static Member[] remove(Member[] all, Member remove) {
        return extract(all, new Member[] { remove });
    }

    /**
     * Removes specified members from an array.
     *
     * @param all the member array
     * @param remove the members to remove
     * @return the array with specified members removed
     */
    public static Member[] extract(Member[] all, Member[] remove) {
        List<Member> alist = java.util.Arrays.asList(all);
        ArrayList<Member> list = new ArrayList<>(alist);
        for (Member member : remove) {
            list.remove(member);
        }
        return list.toArray(new Member[0]);
    }

    /**
     * Finds the index of a member in an array.
     *
     * @param member the member to find
     * @param members the member array
     * @return the index, or -1 if not found
     */
    public static int indexOf(Member member, Member[] members) {
        int result = -1;
        for (int i = 0; (result == -1) && (i < members.length); i++) {
            if (member.equals(members[i])) {
                result = i;
            }
        }
        return result;
    }

    /**
     * Finds the index of the next member after the given one.
     *
     * @param member the current member
     * @param members the member array
     * @return the next index, wrapping to 0 if at end, or -1 if empty
     */
    public static int nextIndex(Member member, Member[] members) {
        int idx = indexOf(member, members) + 1;
        if (idx >= members.length) {
            idx = ((members.length > 0) ? 0 : -1);
        }

        return idx;
    }

    /**
     * Computes a hash code for a byte array.
     *
     * @param a the byte array
     * @return the hash code
     */
    public static int hashCode(byte[] a) {
        if (a == null) {
            return 0;
        }

        int result = 1;
        for (byte element : a) {
            result = 31 * result + element;
        }
        return result;
    }

    /**
     * Parses a byte array from its string representation.
     *
     * @param value the string representation
     * @return the byte array
     */
    public static byte[] fromString(String value) {
        if (value == null) {
            return null;
        }
        if (!value.startsWith("{")) {
            throw new RuntimeException(sm.getString("arrays.malformed.arrays"));
        }
        StringTokenizer t = new StringTokenizer(value, "{,}", false);
        byte[] result = new byte[t.countTokens()];
        for (int i = 0; i < result.length; i++) {
            result[i] = Byte.parseByte(t.nextToken());
        }
        return result;
    }


    /**
     * Converts a string to a byte array using ISO-8859-1 encoding.
     *
     * @param s the string to convert
     * @return the byte array
     */
    public static byte[] convert(String s) {
        return s.getBytes(StandardCharsets.ISO_8859_1);
    }
}
