# -*- coding: utf-8 -*-

# +---------------------------------------------------------------------------+
# |          01001110 01100101 01110100 01111010 01101111 01100010            |
# |                                                                           |
# |               Netzob : Inferring communication protocols                  |
# +---------------------------------------------------------------------------+
# | Copyright (C) 2011-2014 Georges Bossert and Frédéric Guihéry              |
# | This program is free software: you can redistribute it and/or modify      |
# | it under the terms of the GNU General Public License as published by      |
# | the Free Software Foundation, either version 3 of the License, or         |
# | (at your option) any later version.                                       |
# |                                                                           |
# | This program is distributed in the hope that it will be useful,           |
# | but WITHOUT ANY WARRANTY; without even the implied warranty of            |
# | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the              |
# | GNU General Public License for more details.                              |
# |                                                                           |
# | You should have received a copy of the GNU General Public License         |
# | along with this program. If not, see <http://www.gnu.org/licenses/>.      |
# +---------------------------------------------------------------------------+
# | @url      : http://www.netzob.org                                         |
# | @contact  : contact@netzob.org                                            |
# | @sponsors : Amossys, http://www.amossys.fr                                |
# |             Supélec, http://www.rennes.supelec.fr/ren/rd/cidre/           |
# +---------------------------------------------------------------------------+

# +---------------------------------------------------------------------------+
# | File contributors :                                                       |
# |       - Georges Bossert <georges.bossert (a) supelec.fr>                  |
# |       - Frédéric Guihéry <frederic.guihery (a) amossys.fr>                |
# +---------------------------------------------------------------------------+

# +---------------------------------------------------------------------------+
# | Standard library imports                                                  |
# +---------------------------------------------------------------------------+
import threading

# +---------------------------------------------------------------------------+
# | Related third party imports                                               |
# +---------------------------------------------------------------------------+

# +---------------------------------------------------------------------------+
# | Local application imports                                                 |
# +---------------------------------------------------------------------------+
from netzob.Common.Utils.Decorators import typeCheck, NetzobLogger
from netzob.Common.Models.Vocabulary.AbstractField import AbstractField
from netzob.Common.Utils.MatrixList import MatrixList
from netzob.Common.Models.Types.TypeConverter import TypeConverter
from netzob.Common.Models.Types.BitArray import BitArray
from netzob.Common.Models.Types.Raw import Raw


@NetzobLogger
class DataAlignment(threading.Thread):
    """This class allows to align data given a field
    specification. This class inherits from :class:`threading.Thread` which allows
    to execute it asynchronously but also to execute it in a traditionnal way.

    For instance, below is a very simple example of data alignment executed
    traditionnaly

    >>> from netzob.all import *
    >>> from netzob.Common.Utils.DataAlignment.DataAlignment import DataAlignment
    >>> import random
    >>> import string

    >>> contents = ['hello {0} hello'.format(''.join([random.choice(string.letters) for y in range(random.randint(5,10))])) for x in range(10)]
    >>> fields = [Field("hello ", name="f0"), Field(ASCII(nbChars=(5,10)), name="f1"), Field(" hello", name="f2")]
    >>> symbol = Symbol(fields=fields)
    >>> alignedData = DataAlignment.align(contents, symbol, encoded=True)
    >>> print len(alignedData)
    10

    >>> # one more fun test case
    >>> data = ['hello tototo, welcome' for  x in range(5)]
    >>> # Now we create a symbol with its field structure to represent this type of message
    >>> fields = [Field(ASCII('hello '), name="f1"), Field(Agg([Alt([ASCII("toto"), ASCII("to")]), Alt([ASCII("to"), ASCII("toto")])]), name="f2"), Field(ASCII(', welcome'), name="f3")]
    >>> symbol = Symbol(fields=fields)
    >>> alignedData = DataAlignment.align(data, symbol)
    >>> print len(alignedData)
    5
    >>> print alignedData
    f1       | f2       | f3         
    -------- | -------- | -----------
    'hello ' | 'tototo' | ', welcome'
    'hello ' | 'tototo' | ', welcome'
    'hello ' | 'tototo' | ', welcome'
    'hello ' | 'tototo' | ', welcome'
    'hello ' | 'tototo' | ', welcome'
    -------- | -------- | -----------

    >>> # Lets try to align a more complex message
    >>> msg1 = "helloPUTtotoPA343"
    >>> msg2 = "helloGETtototoPA"
    >>> msg3 = "helloPUTtotototoPAdqs4qsd33"
    >>> messages = [msg1, msg2, msg3]
    >>> fh1 = Field("hello", name="f1")
    >>> fh2 = Field(ASCII(nbChars=(3)), name="f2")
    >>> fh3 = Field(Agg([Alt(["toto", "to"]), Alt(["to", "toto"])]), name="f3")
    >>> fb1 = Field(ASCII("PA"), name="f4")
    >>> fb2 = Field(Raw(nbBytes=(0,10)), name="f5")
    >>> headerFields = [fh1, fh2, fh3]
    >>> bodyFields = [fb1, fb2]

    >>> symbol = Symbol(fields=headerFields+bodyFields)
    >>> alignedData2 = DataAlignment.align(messages, symbol)
    >>> print alignedData2
    f1      | f2    | f3         | f4   | f5         
    ------- | ----- | ---------- | ---- | -----------
    'hello' | 'PUT' | 'toto'     | 'PA' | '343'      
    'hello' | 'GET' | 'tototo'   | 'PA' | ''         
    'hello' | 'PUT' | 'totototo' | 'PA' | 'dqs4qsd33'
    ------- | ----- | ---------- | ---- | -----------

    """

    def __init__(self, data, field, depth=None, encoded=True, styled=False):
        """Constructor.

        :param data: the list of data that will be aligned, data must be encoded in HexaString
        :type data: a :class:`list` of data to align
        :param field: the format definition that will be user
        :type field: :class:`netzob.Common.Models.Vocabulary.AbstractField.AbstractField`
        :keyword depth: the limit in depth in the format (use None for not limit)
        :type depth: :class:`int`
        :keyword encoded: indicates if the result should be encoded following field definition
        :type encoded: :class:`bool`
        :keyword styled: indicated if the result visualization filter should be applied
        :type styled: :class:`bool`

        """
        self.data = data
        self.field = field
        self.depth = depth
        self.encoded = encoded
        self.styled = styled

    def execute(self):
        """Execute the alignment of data following specified field
        """
        if self.data is None:
            raise TypeError("Data cannot be None")
        if self.field is None:
            raise TypeError("Field cannot be None")

        # Aligned messages are stored in a MatrixList for better display
        result = MatrixList()        

        # We retrieve all the leaf fields of the root of the provided field
        rootLeafFields = self.__root._getLeafFields(depth=self.depth)
            
        # if self.__root != self.field:
        #     targetedFieldLeafFields = self.field._getLeafFields(depth=self.depth)
        # else:
        targetedFieldLeafFields = rootLeafFields

        result.headers = [str(field.name) for field in targetedFieldLeafFields]
        from netzob.Common.Models.Vocabulary.Domain.Parser.MessageParser import MessageParser
        for d in self.data:
            mp = MessageParser()
            # alignedMsg = mp.parseRaw(TypeConverter.convert(d, HexaString, Raw), targetedFieldLeafFields)
            alignedMsg = mp.parseRaw(d, targetedFieldLeafFields).next()            

            alignedEncodedMsg = []
            for ifield, currentField in enumerate(targetedFieldLeafFields):

                # now we apply encoding and mathematic functions
                fieldValue = alignedMsg[ifield]
            
                if self.encoded and len(currentField.encodingFunctions.values()) > 0:
                    for encodingFunction in currentField.encodingFunctions.values():
                        fieldValue = encodingFunction.encode(fieldValue)
                else:
                    fieldValue = TypeConverter.convert(fieldValue, BitArray, Raw)

                if currentField in self.field._getLeafFields(depth=self.depth):
                    alignedEncodedMsg.append(fieldValue)

            result.append(alignedEncodedMsg)

        return result

    # @typeCheck(str)
    # def __splitDataWithRegex(self, data, fields):
    #     """Split the specified data in possible field following
    #     the application of the regex

    #     :param data: the data to split must be encoded in hexastring
    #     :type data: :class:`str`
    #     :param fields: the list of fields to use to parse the specified data
    #     :type fields: a list of :class:`netzob.Common.Models.Vocabulary.Field.Field`
    #     """

    #     if data is None:
    #         raise TypeError("data cannot be None")

    #     if fields is None:
    #         raise TypeError("fields cannot be None")

    #     if len(fields) == 0:
    #         raise TypeError("At least one field must be specified")

    #     build the regex
    #     regexes = [field.regex for field in fields]
        
    #     regex = NetzobAggregateRegex(regexes)
                    
    #     self._logger.debug("Regex: {0}".format(regex.finalRegex()))

    #     dynamicDatas = None
    #     try:
    #         Now we apply the regex over the message
    #         compiledRegex = re.compile(regex.finalRegex())
    #         validDynamicDatas = compiledRegex.finditer(data)
    #     except Exception, e:
    #         self._logger.warning("An error occured in the alignment process")
    #         self._logger.warning("The regex of the group doesn't match one of its message")
    #         self._logger.warning("Regex: {0}".format(regex.finalRegex()))
    #         if len(data) > 255:
    #             self._logger.warning("Message: {0}...".format(data[:255]))
    #         else:
    #             self._logger.warning("Message: {0}".format(data))
    #         raise e

    #     results = []
    #     for dynamicDatas in validDynamicDatas:
    #         results.append(dynamicDatas.capturesdict())
    #         Memory optimization offered by regex module
    #         dynamicDatas.detach_string()

    #     self._logger.debug("{0} ways of parsing the message with a regex was found.".format(len(results)))
    #     self._logger.debug(results)
            
    #     return results                

    # Static method
    @staticmethod
    @typeCheck(str, AbstractField, int)
    def align(data, field, depth=None, encoded=True):
        """Execute an alignment of specified data with provided field.
        Data must be provided as a list of hexastring.

        :param data: the data to align as a list of hexastring
        :type data: :class:`list`
        :param field : the field to consider when aligning
        :type: :class:`netzob.Common.Models.Vocabulary.AbstractField.AbstractField`
        :keyword depth: maximum field depth to consider (similar to layer depth)
        :type depth: :class:`int`.
        :keyword encoded: set to True if you want the returned result to follow the encoding functions
        :type encoded: :class:`boolean`
        :return: the aligned data
        :rtype: :class:`netzob.Common.Utils.MatrixList.MatrixList`
        """
        
        dAlignment = DataAlignment(data, field, depth, encoded=encoded)
        return dAlignment.execute()

    # Properties

    @property
    def field(self):
        """The field that contains the definition domain used
        to align data

        :type: :class:`netzob.Common.Models.Vocabulary.AbstractField.AbstractField`
        """
        return self.__field

    @field.setter
    @typeCheck(AbstractField)
    def field(self, field):
        if field is None:
            raise TypeError("Field cannot be None")
        self.__field = field
        # update the root
        root = self.__field
        while root.hasParent():
            root = root.parent
        self.__root = root

    @property
    def depth(self):
        """The depth represents the maximum deepness in the fields definition
        that will be considered when aligning messages.

        If set to None, its no limit.

        :type: :class:`int`
        """
        return self.__depth

    @depth.setter
    @typeCheck(int)
    def depth(self, depth):
        if depth is not None and depth < 0:
            raise ValueError("Depth cannot be <0, use None to specify unlimited depth")

        self.__depth = depth

    @property
    def encoded(self):
        """The encoded defines if it applies the encoding filters on aligned data

        :type: :class:`bool`
        """
        return self.__encoded

    @encoded.setter
    @typeCheck(bool)
    def encoded(self, encoded):
        if encoded is None:
            raise ValueError("Encoded cannot be None")

        self.__encoded = encoded

    @property
    def styled(self):
        """The styled defines if it applies the visu filters on aligned data

        :type: :class:`bool`
        """
        return self.__styled

    @styled.setter
    @typeCheck(bool)
    def styled(self, styled):
        if styled is None:
            raise ValueError("Styled cannot be None")

        self.__styled = styled
