common-consts.h

/*
 * Trillian IMPP for libpurple/Pidgin
 * Copyright (c) 2017 Konstantin Kharlamov
 *
 * 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/>.
 */

#ifndef COMMON_CONSTS_H
#define COMMON_CONSTS_H

#include "protocol.h"

const uint8_t magic = 0x6f; // tlv_packet::magic should always be equal to it
const char CLIENT_NAME[]        = "Purple";
const char CLIENT_PLATFORM[]    = "GNU/Linux"; //todo: needs to be detected
const char CLIENT_ARCH[]        = "x86_64"; //todo: detect
const char CLIENT_VERSION[]     = "0.1";
const char CLIENT_BUILD[]       = "0"; //todo: detect
const char DEVICE_NAME[]        = "libpurple"; //todo: trillian uses hostname
const char CLIENT_DESCRIPTION[] = "Multiprotocol messenger based on libpurple";

// 14 is the version of at least 6.0.0 trillian client
const tlv_packet_version templ_version_request = {magic, tlv_packet_header::version, uint16bg_t{14}};

const tlv_packet_data templ_authorize = tlv_packet_data {
    head : tlv_packet_header {
        magic   : magic,
        channel : tlv_packet_header::tlv
    },
    flags    : tlv_packet_data::request,
    family   : tlv_packet_data::stream,
    msg_type : STREAM::AUTHENTICATE,
    sequence : 6,
    block  : {
        tlv_unit {
            type : STREAM::MECHANISM,
            val  : { 0x00, 0x01 }
        },
        tlv_unit {
            type : STREAM::NAME,
            val  : { 0x74, 0x72, 0x69, 0x63, 0x69, 0x61 }
        },
        tlv_unit {
            type : STREAM::PASSWORD,
            val  : { 0x70, 0x61, 0x73, 0x73, 0x77, 0x6F, 0x72, 0x64 }
        }}
};

const tlv_packet_data templ_client_info = tlv_packet_data {
    head : tlv_packet_header {
        magic   : magic,
        channel : tlv_packet_header::tlv
    },
    flags    : tlv_packet_data::request,
    family   : tlv_packet_data::device,
    msg_type : DEVICE::BIND,
    sequence : 7,
    block  : {
        tlv_unit {
            type : DEVICE::CLIENT_NAME,
            val  : { CLIENT_NAME, CLIENT_NAME + sizeof(CLIENT_NAME) - 1 }
        },
        tlv_unit {
            type : DEVICE::CLIENT_PLATFORM,
            val  : { CLIENT_PLATFORM, CLIENT_PLATFORM + sizeof(CLIENT_PLATFORM) - 1 }
        },
        tlv_unit {
            type : DEVICE::CLIENT_ARCH,
            val  : { CLIENT_ARCH, CLIENT_ARCH + sizeof(CLIENT_ARCH) - 1 }
        },
        tlv_unit {
            type : DEVICE::CLIENT_VERSION,
            val  : { CLIENT_VERSION, CLIENT_VERSION + sizeof(CLIENT_VERSION) - 1 }
        },
        tlv_unit {
            type : DEVICE::CLIENT_BUILD,
            val  : { CLIENT_BUILD, CLIENT_BUILD + sizeof(CLIENT_BUILD) - 1 }
        },
        tlv_unit {
            type : DEVICE::DEVICE_NAME,
            val  : { DEVICE_NAME, DEVICE_NAME + sizeof(DEVICE_NAME) - 1 }
        },
        tlv_unit {
            type : DEVICE::STATUS,
            val  : { 0x00, 0x01 } // todo: probably USER_STATUS_ONLINE from docs
        },
        tlv_unit {
            type : DEVICE::IS_STATUS_AUTOMATIC,
            val  : { 0x00 }
        },
        tlv_unit {
            type : DEVICE::CAPABILITIES,
            val  : { 0x00, 0x01, 0x42, 0x04, 0x00, 0x02, 0x42, 0x09, 0x42, 0x03, 0x42, 0x06, 0x42, 0x05, 0x42, 0x07, 0x42, 0x08 }
            // todo: I've no idea what capabilities this is, and docs not very helpful
        },
        tlv_unit {
            type : DEVICE::CLIENT_DESCRIPTION,
            val  : { CLIENT_DESCRIPTION, CLIENT_DESCRIPTION + sizeof(CLIENT_DESCRIPTION) - 1 }
        }}
};

// between different requests changes family and msg_type
const tlv_packet_data templ_basic_request = tlv_packet_data {
    head : tlv_packet_header {
        magic   : magic,
        channel : tlv_packet_header::tlv
    },
    flags    : tlv_packet_data::request,
    family   : tlv_packet_data::lists,
    msg_type : LISTS::GET,
    sequence : 8,
    block  : {}
};

// The body separately is used e.g. for sending a batch of messages
const std::vector<tlv_unit> templ_user_msg_body = {
    tlv_unit {
        type : IM::FROM,
        val  : {}
    },
    tlv_unit {
        type : IM::TO,
        val  : {}
    },
    tlv_unit {
        type : IM::MESSAGE_ID,
        val  : { 0x00, 0x00, 0x00, 0x00 }
    },
    tlv_unit {
        type : IM::MESSAGE_SIZE,
        val  : { 0x00, 0x00, 0x00, 0x00 }
    },
    tlv_unit {
        type : IM::MESSAGE_CHUNK,
        val  : {}
    },
    tlv_unit {
        type : IM::CAPABILITY,
        val  : { 0x00, 0x01 } // IM::CAPABILITY_IM
    },
    tlv_unit {
        type : IM::CREATED_AT,
        val  : { 0x00, 0x00, 0x01, 0x60, 0x86, 0x72, 0x8E, 0xC0 }
    }
};

const tlv_packet_data templ_user_msg = tlv_packet_data {
    head : tlv_packet_header {
        magic   : magic,
        channel : tlv_packet_header::tlv
    },
    flags    : tlv_packet_data::request,
    family   : tlv_packet_data::im,
    msg_type : IM::MESSAGE_SEND,
    sequence : 1,
    block    : templ_user_msg_body
};

const tlv_packet_data templ_ping = tlv_packet_data {
    head : tlv_packet_header {
        magic   : magic,
        channel : tlv_packet_header::tlv
    },
    flags    : tlv_packet_data::request,
    family   : tlv_packet_data::stream,
    msg_type : STREAM::PING,
    sequence : 1,
    block    : {}
};

#endif //COMMON_CONSTS_H