# wireprotoframing.py - unified framing protocol for wire protocol

#

# Copyright 2018 Gregory Szorc <gregory.szorc@gmail.com>

#

# This software may be used and distributed according to the terms of the

# GNU General Public License version 2 or any later version.

# This file contains functionality to support the unified frame-based wire

# protocol. For details about the protocol, see

# `hg help internals.wireprotocol`.

from __future__ import absolute_import

import struct

from .i18n import _

from .thirdparty import (

    attr,

)

from . import (

    error,

    util,

)

from .utils import (

    stringutil,

)

FRAME_HEADER_SIZE = 8

DEFAULT_MAX_FRAME_SIZE = 32768

STREAM_FLAG_BEGIN_STREAM = 0x01

STREAM_FLAG_END_STREAM = 0x02

STREAM_FLAG_ENCODING_APPLIED = 0x04

STREAM_FLAGS = {

    b'stream-begin': STREAM_FLAG_BEGIN_STREAM,

    b'stream-end': STREAM_FLAG_END_STREAM,

    b'encoded': STREAM_FLAG_ENCODING_APPLIED,

}

FRAME_TYPE_COMMAND_NAME = 0x01

FRAME_TYPE_COMMAND_ARGUMENT = 0x02

FRAME_TYPE_COMMAND_DATA = 0x03

FRAME_TYPE_BYTES_RESPONSE = 0x04

FRAME_TYPE_ERROR_RESPONSE = 0x05

FRAME_TYPE_TEXT_OUTPUT = 0x06

FRAME_TYPE_STREAM_SETTINGS = 0x08

FRAME_TYPES = {

    b'command-name': FRAME_TYPE_COMMAND_NAME,

    b'command-argument': FRAME_TYPE_COMMAND_ARGUMENT,

    b'command-data': FRAME_TYPE_COMMAND_DATA,

    b'bytes-response': FRAME_TYPE_BYTES_RESPONSE,

    b'error-response': FRAME_TYPE_ERROR_RESPONSE,

    b'text-output': FRAME_TYPE_TEXT_OUTPUT,

    b'stream-settings': FRAME_TYPE_STREAM_SETTINGS,

}

FLAG_COMMAND_NAME_EOS = 0x01

FLAG_COMMAND_NAME_HAVE_ARGS = 0x02

FLAG_COMMAND_NAME_HAVE_DATA = 0x04

FLAGS_COMMAND = {

    b'eos': FLAG_COMMAND_NAME_EOS,

    b'have-args': FLAG_COMMAND_NAME_HAVE_ARGS,

    b'have-data': FLAG_COMMAND_NAME_HAVE_DATA,

}

FLAG_COMMAND_ARGUMENT_CONTINUATION = 0x01

FLAG_COMMAND_ARGUMENT_EOA = 0x02

FLAGS_COMMAND_ARGUMENT = {

    b'continuation': FLAG_COMMAND_ARGUMENT_CONTINUATION,

    b'eoa': FLAG_COMMAND_ARGUMENT_EOA,

}

FLAG_COMMAND_DATA_CONTINUATION = 0x01

FLAG_COMMAND_DATA_EOS = 0x02

FLAGS_COMMAND_DATA = {

    b'continuation': FLAG_COMMAND_DATA_CONTINUATION,

    b'eos': FLAG_COMMAND_DATA_EOS,

}

FLAG_BYTES_RESPONSE_CONTINUATION = 0x01

FLAG_BYTES_RESPONSE_EOS = 0x02

FLAGS_BYTES_RESPONSE = {

    b'continuation': FLAG_BYTES_RESPONSE_CONTINUATION,

    b'eos': FLAG_BYTES_RESPONSE_EOS,

}

FLAG_ERROR_RESPONSE_PROTOCOL = 0x01

FLAG_ERROR_RESPONSE_APPLICATION = 0x02

FLAGS_ERROR_RESPONSE = {

    b'protocol': FLAG_ERROR_RESPONSE_PROTOCOL,

    b'application': FLAG_ERROR_RESPONSE_APPLICATION,

}

# Maps frame types to their available flags.

FRAME_TYPE_FLAGS = {

    FRAME_TYPE_COMMAND_NAME: FLAGS_COMMAND,

    FRAME_TYPE_COMMAND_ARGUMENT: FLAGS_COMMAND_ARGUMENT,

    FRAME_TYPE_COMMAND_DATA: FLAGS_COMMAND_DATA,

    FRAME_TYPE_BYTES_RESPONSE: FLAGS_BYTES_RESPONSE,

    FRAME_TYPE_ERROR_RESPONSE: FLAGS_ERROR_RESPONSE,

    FRAME_TYPE_TEXT_OUTPUT: {},

    FRAME_TYPE_STREAM_SETTINGS: {},

}

ARGUMENT_FRAME_HEADER = struct.Struct(r'<HH')

@attr.s(slots=True)

class frameheader(object):

    """Represents the data in a frame header."""

    length = attr.ib()

    requestid = attr.ib()

    streamid = attr.ib()

    streamflags = attr.ib()

    typeid = attr.ib()

    flags = attr.ib()

@attr.s(slots=True)

class frame(object):

    """Represents a parsed frame."""

    requestid = attr.ib()

    streamid = attr.ib()

    streamflags = attr.ib()

    typeid = attr.ib()

    flags = attr.ib()

    payload = attr.ib()

def makeframe(requestid, streamid, streamflags, typeid, flags, payload):

    """Assemble a frame into a byte array."""

    # TODO assert size of payload.

    frame = bytearray(FRAME_HEADER_SIZE + len(payload))

    # 24 bits length

    # 16 bits request id

    # 8 bits stream id

    # 8 bits stream flags

    # 4 bits type

    # 4 bits flags

    l = struct.pack(r'<I', len(payload))

    frame[0:3] = l[0:3]

    struct.pack_into(r'<HBB', frame, 3, requestid, streamid, streamflags)

    frame[7] = (typeid << 4) | flags

    frame[8:] = payload

    return frame

def makeframefromhumanstring(s):

    """Create a frame from a human readable string

    Strings have the form:

        <request-id> <stream-id> <stream-flags> <type> <flags> <payload>

    This can be used by user-facing applications and tests for creating

    frames easily without having to type out a bunch of constants.

    Request ID and stream IDs are integers.

    Stream flags, frame type, and flags can be specified by integer or

    named constant.

    Flags can be delimited by `|` to bitwise OR them together.

    """

    fields = s.split(b' ', 5)

    requestid, streamid, streamflags, frametype, frameflags, payload = fields

    requestid = int(requestid)

    streamid = int(streamid)

    finalstreamflags = 0

    for flag in streamflags.split(b'|'):

        if flag in STREAM_FLAGS:

            finalstreamflags |= STREAM_FLAGS[flag]

        else:

            finalstreamflags |= int(flag)

    if frametype in FRAME_TYPES:

        frametype = FRAME_TYPES[frametype]

    else:

        frametype = int(frametype)

    finalflags = 0

    validflags = FRAME_TYPE_FLAGS[frametype]

    for flag in frameflags.split(b'|'):

        if flag in validflags:

            finalflags |= validflags[flag]

        else:

            finalflags |= int(flag)

    return makeframe(requestid=requestid, streamid=streamid,

                     streamflags=finalstreamflags, typeid=frametype,

                     flags=finalflags, payload=payload)

def parseheader(data):

    """Parse a unified framing protocol frame header from a buffer.

    The header is expected to be in the buffer at offset 0 and the

    buffer is expected to be large enough to hold a full header.

    """

    # 24 bits payload length (little endian)

    # 16 bits request ID

    # 8 bits stream ID

    # 8 bits stream flags

    # 4 bits frame type

    # 4 bits frame flags

    # ... payload

    framelength = data[0] + 256 * data[1] + 16384 * data[2]

    requestid, streamid, streamflags = struct.unpack_from(r'<HBB', data, 3)

    typeflags = data[7]

    frametype = (typeflags & 0xf0) >> 4

    frameflags = typeflags & 0x0f

    return frameheader(framelength, requestid, streamid, streamflags,

                       frametype, frameflags)

def readframe(fh):

    """Read a unified framing protocol frame from a file object.

    Returns a 3-tuple of (type, flags, payload) for the decoded frame or

    None if no frame is available. May raise if a malformed frame is

    seen.

    """

    header = bytearray(FRAME_HEADER_SIZE)

    readcount = fh.readinto(header)

    if readcount == 0:

        return None

    if readcount != FRAME_HEADER_SIZE:

        raise error.Abort(_('received incomplete frame: got %d bytes: %s') %

                          (readcount, header))

    h = parseheader(header)

    payload = fh.read(h.length)

    if len(payload) != h.length:

        raise error.Abort(_('frame length error: expected %d; got %d') %

                          (h.length, len(payload)))

    return frame(h.requestid, h.streamid, h.streamflags, h.typeid, h.flags,

                 payload)

def createcommandframes(stream, requestid, cmd, args, datafh=None):

    """Create frames necessary to transmit a request to run a command.

    This is a generator of bytearrays. Each item represents a frame

    ready to be sent over the wire to a peer.

    """

    flags = 0

    if args:

        flags |= FLAG_COMMAND_NAME_HAVE_ARGS

    if datafh:

        flags |= FLAG_COMMAND_NAME_HAVE_DATA

    if not flags:

        flags |= FLAG_COMMAND_NAME_EOS

    yield stream.makeframe(requestid=requestid, typeid=FRAME_TYPE_COMMAND_NAME,

                           flags=flags, payload=cmd)

    for i, k in enumerate(sorted(args)):

        v = args[k]

        last = i == len(args) - 1

        # TODO handle splitting of argument values across frames.

        payload = bytearray(ARGUMENT_FRAME_HEADER.size + len(k) + len(v))

        offset = 0

        ARGUMENT_FRAME_HEADER.pack_into(payload, offset, len(k), len(v))

        offset += ARGUMENT_FRAME_HEADER.size

        payload[offset:offset + len(k)] = k

        offset += len(k)

        payload[offset:offset + len(v)] = v

        flags = FLAG_COMMAND_ARGUMENT_EOA if last else 0

        yield stream.makeframe(requestid=requestid,

                               typeid=FRAME_TYPE_COMMAND_ARGUMENT,

                               flags=flags,

                               payload=payload)

    if datafh:

        while True:

            data = datafh.read(DEFAULT_MAX_FRAME_SIZE)

            done = False

            if len(data) == DEFAULT_MAX_FRAME_SIZE:

                flags = FLAG_COMMAND_DATA_CONTINUATION

            else:

                flags = FLAG_COMMAND_DATA_EOS

                assert datafh.read(1) == b''

                done = True

            yield stream.makeframe(requestid=requestid,

                                   typeid=FRAME_TYPE_COMMAND_DATA,

                                   flags=flags,

                                   payload=data)

            if done:

                break

def createbytesresponseframesfrombytes(stream, requestid, data,

                                       maxframesize=DEFAULT_MAX_FRAME_SIZE):

    """Create a raw frame to send a bytes response from static bytes input.

    Returns a generator of bytearrays.

    """

    # Simple case of a single frame.

    if len(data) <= maxframesize:

        yield stream.makeframe(requestid=requestid,

                               typeid=FRAME_TYPE_BYTES_RESPONSE,

                               flags=FLAG_BYTES_RESPONSE_EOS,

                               payload=data)

        return

    offset = 0

    while True:

        chunk = data[offset:offset + maxframesize]

        offset += len(chunk)

        done = offset == len(data)

        if done:

            flags = FLAG_BYTES_RESPONSE_EOS

        else:

            flags = FLAG_BYTES_RESPONSE_CONTINUATION

        yield stream.makeframe(requestid=requestid,

                               typeid=FRAME_TYPE_BYTES_RESPONSE,

                               flags=flags,

                               payload=chunk)

        if done:

            break

def createerrorframe(stream, requestid, msg, protocol=False, application=False):

    # TODO properly handle frame size limits.

    assert len(msg) <= DEFAULT_MAX_FRAME_SIZE

    flags = 0

    if protocol:

        flags |= FLAG_ERROR_RESPONSE_PROTOCOL

    if application:

        flags |= FLAG_ERROR_RESPONSE_APPLICATION

    yield stream.makeframe(requestid=requestid,

                           typeid=FRAME_TYPE_ERROR_RESPONSE,

                           flags=flags,

                           payload=msg)

def createtextoutputframe(stream, requestid, atoms):

    """Create a text output frame to render text to people.

    ``atoms`` is a 3-tuple of (formatting string, args, labels).

    The formatting string contains ``%s`` tokens to be replaced by the

    corresponding indexed entry in ``args``. ``labels`` is an iterable of

    formatters to be applied at rendering time. In terms of the ``ui``

    class, each atom corresponds to a ``ui.write()``.

    """

    bytesleft = DEFAULT_MAX_FRAME_SIZE

    atomchunks = []

    for (formatting, args, labels) in atoms:

        if len(args) > 255:

            raise ValueError('cannot use more than 255 formatting arguments')

        if len(labels) > 255:

            raise ValueError('cannot use more than 255 labels')

        # TODO look for localstr, other types here?

        if not isinstance(formatting, bytes):

            raise ValueError('must use bytes formatting strings')

        for arg in args:

            if not isinstance(arg, bytes):

                raise ValueError('must use bytes for arguments')

        for label in labels:

            if not isinstance(label, bytes):

                raise ValueError('must use bytes for labels')

        # Formatting string must be UTF-8.

        formatting = formatting.decode(r'utf-8', r'replace').encode(r'utf-8')

        # Arguments must be UTF-8.

        args = [a.decode(r'utf-8', r'replace').encode(r'utf-8') for a in args]

        # Labels must be ASCII.

        labels = [l.decode(r'ascii', r'strict').encode(r'ascii')

                  for l in labels]

        if len(formatting) > 65535:

            raise ValueError('formatting string cannot be longer than 64k')

        if any(len(a) > 65535 for a in args):

            raise ValueError('argument string cannot be longer than 64k')

        if any(len(l) > 255 for l in labels):

            raise ValueError('label string cannot be longer than 255 bytes')

        chunks = [

            struct.pack(r'<H', len(formatting)),

            struct.pack(r'<BB', len(labels), len(args)),

            struct.pack(r'<' + r'B' * len(labels), *map(len, labels)),

            struct.pack(r'<' + r'H' * len(args), *map(len, args)),

        ]

        chunks.append(formatting)

        chunks.extend(labels)

        chunks.extend(args)

        atom = b''.join(chunks)

        atomchunks.append(atom)

        bytesleft -= len(atom)

    if bytesleft < 0:

        raise ValueError('cannot encode data in a single frame')

    yield stream.makeframe(requestid=requestid,

                           typeid=FRAME_TYPE_TEXT_OUTPUT,

                           flags=0,

                           payload=b''.join(atomchunks))

class stream(object):

    """Represents a logical unidirectional series of frames."""

    def __init__(self, streamid, active=False):

        self.streamid = streamid

        self._active = False

    def makeframe(self, requestid, typeid, flags, payload):

        """Create a frame to be sent out over this stream.

        Only returns the frame instance. Does not actually send it.

        """

        streamflags = 0

        if not self._active:

            streamflags |= STREAM_FLAG_BEGIN_STREAM

            self._active = True

        return makeframe(requestid, self.streamid, streamflags, typeid, flags,

                         payload)

def ensureserverstream(stream):

    if stream.streamid % 2:

        raise error.ProgrammingError('server should only write to even '

                                     'numbered streams; %d is not even' %

                                     stream.streamid)

class serverreactor(object):

    """Holds state of a server handling frame-based protocol requests.

    This class is the "brain" of the unified frame-based protocol server

    component. While the protocol is stateless from the perspective of

    requests/commands, something needs to track which frames have been

    received, what frames to expect, etc. This class is that thing.

    Instances are modeled as a state machine of sorts. Instances are also

    reactionary to external events. The point of this class is to encapsulate

    the state of the connection and the exchange of frames, not to perform

    work. Instead, callers tell this class when something occurs, like a

    frame arriving. If that activity is worthy of a follow-up action (say

    *run a command*), the return value of that handler will say so.

    I/O and CPU intensive operations are purposefully delegated outside of

    this class.

    Consumers are expected to tell instances when events occur. They do so by

    calling the various ``on*`` methods. These methods return a 2-tuple

    describing any follow-up action(s) to take. The first element is the

    name of an action to perform. The second is a data structure (usually

    a dict) specific to that action that contains more information. e.g.

    if the server wants to send frames back to the client, the data structure

    will contain a reference to those frames.

    Valid actions that consumers can be instructed to take are: