/* Messenger.h * * An implementation of a simple text chat only messenger on the tox network core. * * NOTE: All the text in the messages must be encoded using UTF-8 * * Copyright (C) 2013 Tox project All Rights Reserved. * * This file is part of Tox. * * Tox 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. * * Tox 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 Tox. If not, see . * */ #ifndef MESSENGER_H #define MESSENGER_H #include "friend_requests.h" #include "LAN_discovery.h" #include "friend_connection.h" #define MAX_NAME_LENGTH 128 /* TODO: this must depend on other variable. */ #define MAX_STATUSMESSAGE_LENGTH 1007 #define AVATAR_MAX_DATA_LENGTH 16384 #define AVATAR_HASH_LENGTH crypto_hash_sha256_BYTES #define FRIEND_ADDRESS_SIZE (crypto_box_PUBLICKEYBYTES + sizeof(uint32_t) + sizeof(uint16_t)) /* NOTE: Packet ids below 17 must never be used. */ #define PACKET_ID_SHARE_RELAYS 17 #define PACKET_ID_ONLINE 24 #define PACKET_ID_OFFLINE 25 #define PACKET_ID_NICKNAME 48 #define PACKET_ID_STATUSMESSAGE 49 #define PACKET_ID_USERSTATUS 50 #define PACKET_ID_TYPING 51 #define PACKET_ID_AVATAR_INFO_REQ 52 #define PACKET_ID_AVATAR_INFO 53 #define PACKET_ID_AVATAR_DATA_CONTROL 54 #define PACKET_ID_AVATAR_DATA_START 55 #define PACKET_ID_AVATAR_DATA_PUSH 56 #define PACKET_ID_RECEIPT 63 #define PACKET_ID_MESSAGE 64 #define PACKET_ID_ACTION 65 #define PACKET_ID_MSI 69 #define PACKET_ID_FILE_SENDREQUEST 80 #define PACKET_ID_FILE_CONTROL 81 #define PACKET_ID_FILE_DATA 82 #define PACKET_ID_INVITE_GROUPCHAT 96 #define PACKET_ID_ONLINE_PACKET 97 #define PACKET_ID_DIRECT_GROUPCHAT 98 #define PACKET_ID_MESSAGE_GROUPCHAT 99 #define PACKET_ID_LOSSY_GROUPCHAT 199 /* Max number of tcp relays sent to friends */ #define MAX_SHARED_RELAYS 16 /* All packets starting with a byte in this range can be used for anything. */ #define PACKET_ID_LOSSLESS_RANGE_START 160 #define PACKET_ID_LOSSLESS_RANGE_SIZE 32 typedef struct { uint8_t ipv6enabled; uint8_t udp_disabled; TCP_Proxy_Info proxy_info; } Messenger_Options; /* Status definitions. */ enum { NOFRIEND, FRIEND_ADDED, FRIEND_REQUESTED, FRIEND_CONFIRMED, FRIEND_ONLINE, }; /* Errors for m_addfriend * FAERR - Friend Add Error */ enum { FAERR_TOOLONG = -1, FAERR_NOMESSAGE = -2, FAERR_OWNKEY = -3, FAERR_ALREADYSENT = -4, FAERR_UNKNOWN = -5, FAERR_BADCHECKSUM = -6, FAERR_SETNEWNOSPAM = -7, FAERR_NOMEM = -8 }; /* Default start timeout in seconds between friend requests. */ #define FRIENDREQUEST_TIMEOUT 5; /* Interval between the sending of tcp relay information */ #define FRIEND_SHARE_RELAYS_INTERVAL (5 * 60) /* Must be < MAX_CRYPTO_DATA_SIZE */ #define AVATAR_DATA_MAX_CHUNK_SIZE (MAX_CRYPTO_DATA_SIZE-1) /* Per-friend data limit for avatar data requests */ #define AVATAR_DATA_TRANSFER_LIMIT (10*AVATAR_MAX_DATA_LENGTH) #define AVATAR_DATA_TRANSFER_TIMEOUT (60) /* 164kB every 60 seconds is not a lot */ /* USERSTATUS - * Represents userstatuses someone can have. */ typedef enum { USERSTATUS_NONE, USERSTATUS_AWAY, USERSTATUS_BUSY, USERSTATUS_INVALID } USERSTATUS; /* AVATAR_FORMAT - * Data formats for user avatar images */ typedef enum { AVATAR_FORMAT_NONE = 0, AVATAR_FORMAT_PNG } AVATAR_FORMAT; /* AVATAR_DATACONTROL * To control avatar data requests (PACKET_ID_AVATAR_DATA_CONTROL) */ typedef enum { AVATAR_DATACONTROL_REQ, AVATAR_DATACONTROL_ERROR } AVATAR_DATACONTROL; typedef struct { uint8_t started; AVATAR_FORMAT format; uint8_t hash[AVATAR_HASH_LENGTH]; uint32_t total_length; uint32_t bytes_received; uint8_t data[AVATAR_MAX_DATA_LENGTH]; } AVATAR_RECEIVEDATA; typedef struct { /* Fields only used to limit the network usage from a given friend */ uint32_t bytes_sent; /* Total bytes send to this user */ uint64_t last_reset; /* Time the data counter was last reset */ } AVATAR_SENDDATA; struct File_Transfers { uint64_t size; uint64_t transferred; uint8_t status; /* 0 == no transfer, 1 = not accepted, 2 = paused by the other, 3 = transferring, 4 = broken, 5 = paused by us */ }; enum { FILESTATUS_NONE, FILESTATUS_NOT_ACCEPTED, FILESTATUS_PAUSED_BY_OTHER, FILESTATUS_TRANSFERRING, FILESTATUS_BROKEN, FILESTATUS_PAUSED_BY_US, FILESTATUS_TEMPORARY }; /* This cannot be bigger than 256 */ #define MAX_CONCURRENT_FILE_PIPES 256 enum { FILECONTROL_ACCEPT, FILECONTROL_PAUSE, FILECONTROL_KILL, FILECONTROL_FINISHED, FILECONTROL_RESUME_BROKEN }; typedef struct Messenger Messenger; typedef struct { uint8_t real_pk[crypto_box_PUBLICKEYBYTES]; int friendcon_id; uint64_t friendrequest_lastsent; // Time at which the last friend request was sent. uint32_t friendrequest_timeout; // The timeout between successful friendrequest sending attempts. uint8_t status; // 0 if no friend, 1 if added, 2 if friend request sent, 3 if confirmed friend, 4 if online. uint8_t info[MAX_FRIEND_REQUEST_DATA_SIZE]; // the data that is sent during the friend requests we do. uint8_t name[MAX_NAME_LENGTH]; uint16_t name_length; uint8_t name_sent; // 0 if we didn't send our name to this friend 1 if we have. uint8_t *statusmessage; uint16_t statusmessage_length; uint8_t statusmessage_sent; USERSTATUS userstatus; uint8_t userstatus_sent; uint8_t avatar_info_sent; uint8_t user_istyping; uint8_t user_istyping_sent; uint8_t is_typing; uint16_t info_size; // Length of the info. uint32_t message_id; // a semi-unique id used in read receipts. uint8_t receives_read_receipts; // shall we send read receipts to this person? uint32_t friendrequest_nospam; // The nospam number used in the friend request. uint64_t ping_lastrecv;//TODO remove uint64_t share_relays_lastsent; struct File_Transfers file_sending[MAX_CONCURRENT_FILE_PIPES]; struct File_Transfers file_receiving[MAX_CONCURRENT_FILE_PIPES]; AVATAR_SENDDATA avatar_send_data; AVATAR_RECEIVEDATA *avatar_recv_data; // We are receiving avatar data from this friend. struct { int (*function)(Messenger *m, int32_t friendnumber, const uint8_t *data, uint32_t len, void *object); void *object; } lossy_packethandlers[PACKET_ID_LOSSY_RANGE_SIZE]; struct { int (*function)(Messenger *m, int32_t friendnumber, const uint8_t *data, uint32_t len, void *object); void *object; } lossless_packethandlers[PACKET_ID_LOSSLESS_RANGE_SIZE]; } Friend; struct Messenger { Networking_Core *net; Net_Crypto *net_crypto; DHT *dht; Onion *onion; Onion_Announce *onion_a; Onion_Client *onion_c; Friend_Connections *fr_c; Friend_Requests fr; uint8_t name[MAX_NAME_LENGTH]; uint16_t name_length; uint8_t statusmessage[MAX_STATUSMESSAGE_LENGTH]; uint16_t statusmessage_length; USERSTATUS userstatus; AVATAR_FORMAT avatar_format; uint8_t *avatar_data; uint32_t avatar_data_length; uint8_t avatar_hash[AVATAR_HASH_LENGTH]; Friend *friendlist; uint32_t numfriends; uint32_t numonline_friends; uint64_t last_LANdiscovery; #define NUM_SAVED_TCP_RELAYS 8 uint8_t has_added_relays; // If the first connection has occurred in do_messenger Node_format loaded_relays[NUM_SAVED_TCP_RELAYS]; // Relays loaded from config void (*friend_message)(struct Messenger *m, int32_t, const uint8_t *, uint16_t, void *); void *friend_message_userdata; void (*friend_action)(struct Messenger *m, int32_t, const uint8_t *, uint16_t, void *); void *friend_action_userdata; void (*friend_namechange)(struct Messenger *m, int32_t, const uint8_t *, uint16_t, void *); void *friend_namechange_userdata; void (*friend_statusmessagechange)(struct Messenger *m, int32_t, const uint8_t *, uint16_t, void *); void *friend_statusmessagechange_userdata; void (*friend_userstatuschange)(struct Messenger *m, int32_t, uint8_t, void *); void *friend_userstatuschange_userdata; void (*friend_typingchange)(struct Messenger *m, int32_t, uint8_t, void *); void *friend_typingchange_userdata; void (*read_receipt)(struct Messenger *m, int32_t, uint32_t, void *); void *read_receipt_userdata; void (*friend_statuschange)(struct Messenger *m, int32_t, uint8_t, void *); void *friend_statuschange_userdata; void (*friend_connectionstatuschange)(struct Messenger *m, int32_t, uint8_t, void *); void *friend_connectionstatuschange_userdata; void (*friend_connectionstatuschange_internal)(struct Messenger *m, int32_t, uint8_t, void *); void *friend_connectionstatuschange_internal_userdata; void *avatar_info_recv_userdata; void (*avatar_info_recv)(struct Messenger *m, int32_t, uint8_t, uint8_t *, void *); void *avatar_data_recv_userdata; void (*avatar_data_recv)(struct Messenger *m, int32_t, uint8_t, uint8_t *, uint8_t *, uint32_t, void *); void *group_chat_object; /* Set by new_groupchats()*/ void (*group_invite)(struct Messenger *m, int32_t, const uint8_t *, uint16_t); void (*group_message)(struct Messenger *m, int32_t, const uint8_t *, uint16_t); void (*file_sendrequest)(struct Messenger *m, int32_t, uint8_t, uint64_t, const uint8_t *, uint16_t, void *); void *file_sendrequest_userdata; void (*file_filecontrol)(struct Messenger *m, int32_t, uint8_t, uint8_t, uint8_t, const uint8_t *, uint16_t, void *); void *file_filecontrol_userdata; void (*file_filedata)(struct Messenger *m, int32_t, uint8_t, const uint8_t *, uint16_t length, void *); void *file_filedata_userdata; void (*msi_packet)(struct Messenger *m, int32_t, const uint8_t *, uint16_t, void *); void *msi_packet_userdata; Messenger_Options options; }; /* Format: [real_pk (32 bytes)][nospam number (4 bytes)][checksum (2 bytes)] * * return FRIEND_ADDRESS_SIZE byte address to give to others. */ void getaddress(const Messenger *m, uint8_t *address); /* Add a friend. * Set the data that will be sent along with friend request. * address is the address of the friend (returned by getaddress of the friend you wish to add) it must be FRIEND_ADDRESS_SIZE bytes. TODO: add checksum. * data is the data and length is the length. * * return the friend number if success. * return -1 if message length is too long. * return -2 if no message (message length must be >= 1 byte). * return -3 if user's own key. * return -4 if friend request already sent or already a friend. * return -5 for unknown error. * return -6 if bad checksum in address. * return -7 if the friend was already there but the nospam was different. * (the nospam for that friend was set to the new one). * return -8 if increasing the friend list size fails. */ int32_t m_addfriend(Messenger *m, const uint8_t *address, const uint8_t *data, uint16_t length); /* Add a friend without sending a friendrequest. * return the friend number if success. * return -1 if failure. */ int32_t m_addfriend_norequest(Messenger *m, const uint8_t *real_pk); /* return the friend number associated to that client id. * return -1 if no such friend. */ int32_t getfriend_id(const Messenger *m, const uint8_t *real_pk); /* Copies the public key associated to that friend id into real_pk buffer. * Make sure that real_pk is of size crypto_box_PUBLICKEYBYTES. * * return 0 if success * return -1 if failure */ int get_real_pk(const Messenger *m, int32_t friendnumber, uint8_t *real_pk); /* return friend connection id on success. * return -1 if failure. */ int getfriendcon_id(const Messenger *m, int32_t friendnumber); /* Remove a friend. * * return 0 if success * return -1 if failure */ int m_delfriend(Messenger *m, int32_t friendnumber); /* Checks friend's connecting status. * * return 1 if friend is connected to us (Online). * return 0 if friend is not connected to us (Offline). * return -1 on failure. */ int m_get_friend_connectionstatus(const Messenger *m, int32_t friendnumber); /* Checks if there exists a friend with given friendnumber. * * return 1 if friend exists. * return 0 if friend doesn't exist. */ int m_friend_exists(const Messenger *m, int32_t friendnumber); /* Send a text chat message to an online friend. * * return the message id if packet was successfully put into the send queue. * return 0 if it was not. * * You will want to retain the return value, it will be passed to your read_receipt callback * if one is received. * m_sendmessage_withid will send a message with the id of your choosing, * however we can generate an id for you by calling plain m_sendmessage. */ uint32_t m_sendmessage(Messenger *m, int32_t friendnumber, const uint8_t *message, uint32_t length); uint32_t m_sendmessage_withid(Messenger *m, int32_t friendnumber, uint32_t theid, const uint8_t *message, uint32_t length); /* Send an action to an online friend. * * return the message id if packet was successfully put into the send queue. * return 0 if it was not. * * You will want to retain the return value, it will be passed to your read_receipt callback * if one is received. * m_sendaction_withid will send an action message with the id of your choosing, * however we can generate an id for you by calling plain m_sendaction. */ uint32_t m_sendaction(Messenger *m, int32_t friendnumber, const uint8_t *action, uint32_t length); uint32_t m_sendaction_withid(const Messenger *m, int32_t friendnumber, uint32_t theid, const uint8_t *action, uint32_t length); /* Set the name and name_length of a friend. * name must be a string of maximum MAX_NAME_LENGTH length. * length must be at least 1 byte. * length is the length of name with the NULL terminator. * * return 0 if success. * return -1 if failure. */ int setfriendname(Messenger *m, int32_t friendnumber, const uint8_t *name, uint16_t length); /* Set our nickname. * name must be a string of maximum MAX_NAME_LENGTH length. * length must be at least 1 byte. * length is the length of name with the NULL terminator. * * return 0 if success. * return -1 if failure. */ int setname(Messenger *m, const uint8_t *name, uint16_t length); /* * Get your nickname. * m - The messenger context to use. * name needs to be a valid memory location with a size of at least MAX_NAME_LENGTH bytes. * * return length of the name. * return 0 on error. */ uint16_t getself_name(const Messenger *m, uint8_t *name); /* Get name of friendnumber and put it in name. * name needs to be a valid memory location with a size of at least MAX_NAME_LENGTH (128) bytes. * * return length of name if success. * return -1 if failure. */ int getname(const Messenger *m, int32_t friendnumber, uint8_t *name); /* return the length of name, including null on success. * return -1 on failure. */ int m_get_name_size(const Messenger *m, int32_t friendnumber); int m_get_self_name_size(const Messenger *m); /* Set our user status. * You are responsible for freeing status after. * * returns 0 on success. * returns -1 on failure. */ int m_set_statusmessage(Messenger *m, const uint8_t *status, uint16_t length); int m_set_userstatus(Messenger *m, uint8_t status); /* return the length of friendnumber's status message, including null on success. * return -1 on failure. */ int m_get_statusmessage_size(const Messenger *m, int32_t friendnumber); int m_get_self_statusmessage_size(const Messenger *m); /* Copy friendnumber's status message into buf, truncating if size is over maxlen. * Get the size you need to allocate from m_get_statusmessage_size. * The self variant will copy our own status message. * * returns the length of the copied data on success * retruns -1 on failure. */ int m_copy_statusmessage(const Messenger *m, int32_t friendnumber, uint8_t *buf, uint32_t maxlen); int m_copy_self_statusmessage(const Messenger *m, uint8_t *buf, uint32_t maxlen); /* return one of USERSTATUS values. * Values unknown to your application should be represented as USERSTATUS_NONE. * As above, the self variant will return our own USERSTATUS. * If friendnumber is invalid, this shall return USERSTATUS_INVALID. */ uint8_t m_get_userstatus(const Messenger *m, int32_t friendnumber); uint8_t m_get_self_userstatus(const Messenger *m); /* Set the user avatar image data. * This should be made before connecting, so we will not announce that the user have no avatar * before setting and announcing a new one, forcing the peers to re-download it. * * Notice that the library treats the image as raw data and does not interpret it by any way. * * Arguments: * format - Avatar image format or NONE for user with no avatar (see AVATAR_FORMAT); * data - pointer to the avatar data (may be NULL it the format is NONE); * length - length of image data. Must be <= MAX_AVATAR_DATA_LENGTH. * * returns 0 on success * returns -1 on failure. */ int m_set_avatar(Messenger *m, uint8_t format, const uint8_t *data, uint32_t length); /* Unsets the user avatar. returns 0 on success (currently always returns 0) */ int m_unset_avatar(Messenger *m); /* Get avatar data from the current user. * Copies the current user avatar data to the destination buffer and sets the image format * accordingly. * * If the avatar format is NONE, the buffer 'buf' isleft uninitialized, 'hash' is zeroed, and * 'length' is set to zero. * * If any of the pointers format, buf, length, and hash are NULL, that particular field will be ignored. * * Arguments: * format - destination pointer to the avatar image format (see AVATAR_FORMAT); * buf - destination buffer to the image data. Must have at least 'maxlen' bytes; * length - destination pointer to the image data length; * maxlen - length of the destination buffer 'buf'; * hash - destination pointer to the avatar hash (it must be exactly AVATAR_HASH_LENGTH bytes long). * * returns 0 on success; * returns -1 on failure. * */ int m_get_self_avatar(const Messenger *m, uint8_t *format, uint8_t *buf, uint32_t *length, uint32_t maxlen, uint8_t *hash); /* Generates a cryptographic hash of the given data. * This function may be used by clients for any purpose, but is provided primarily for * validating cached avatars. * This function is a wrapper to internal message-digest functions. * * Arguments: * hash - destination buffer for the hash data, it must be exactly crypto_hash_sha256_BYTES bytes long. * data - data to be hashed; * datalen - length of the data; * * returns 0 on success * returns -1 on failure. */ int m_hash(uint8_t *hash, const uint8_t *data, const uint32_t datalen); /* Generates a cryptographic hash of the given avatar data. * This function is a wrapper to m_hash and specifically provided * to generate hashes from user avatars that may be memcmp()ed with the values returned by the * other avatar functions. It is specially important to validate cached avatars. * * Arguments: * hash - destination buffer for the hash data, it must be exactly AVATAR_HASH_LENGTH bytes long. * data - avatar image data; * datalen - length of the avatar image data; it must be <= MAX_AVATAR_DATA_LENGTH. * * returns 0 on success * returns -1 on failure. */ int m_avatar_hash(uint8_t *hash, const uint8_t *data, const uint32_t datalen); /* Request avatar information from a friend. * Asks a friend to provide their avatar information (image format and hash). The friend may * or may not answer this request and, if answered, the information will be provided through * the callback 'avatar_info'. * * returns 0 on success * returns -1 on failure. */ int m_request_avatar_info(const Messenger *m, const int32_t friendnumber); /* Send an unrequested avatar information to a friend. * Sends our avatar format and hash to a friend; he/she can use this information to validate * an avatar from the cache and may (or not) reply with an avatar data request. * * Notice: it is NOT necessary to send these notification after changing the avatar or * connecting. The library already does this. * * returns 0 on success * returns -1 on failure. */ int m_send_avatar_info(const Messenger *m, const int32_t friendnumber); /* Request the avatar data from a friend. * Ask a friend to send their avatar data. The friend may or may not answer this request and, * if answered, the information will be provided in callback 'avatar_data'. * * returns 0 on sucess * returns -1 on failure. */ int m_request_avatar_data(const Messenger *m, const int32_t friendnumber); /* returns timestamp of last time friendnumber was seen online, or 0 if never seen. * returns -1 on error. */ uint64_t m_get_last_online(const Messenger *m, int32_t friendnumber); /* Set our typing status for a friend. * You are responsible for turning it on or off. * * returns 0 on success. * returns -1 on failure. */ int m_set_usertyping(Messenger *m, int32_t friendnumber, uint8_t is_typing); /* Get the typing status of a friend. * * returns 0 if friend is not typing. * returns 1 if friend is typing. */ uint8_t m_get_istyping(const Messenger *m, int32_t friendnumber); /* Sets whether we send read receipts for friendnumber. * This function is not lazy, and it will fail if yesno is not (0 or 1). */ void m_set_sends_receipts(Messenger *m, int32_t friendnumber, int yesno); /* Set the function that will be executed when a friend request is received. * Function format is function(uint8_t * public_key, uint8_t * data, uint16_t length) */ void m_callback_friendrequest(Messenger *m, void (*function)(Messenger *m, const uint8_t *, const uint8_t *, uint16_t, void *), void *userdata); /* Set the function that will be executed when a message from a friend is received. * Function format is: function(int32_t friendnumber, uint8_t * message, uint32_t length) */ void m_callback_friendmessage(Messenger *m, void (*function)(Messenger *m, int32_t, const uint8_t *, uint16_t, void *), void *userdata); /* Set the function that will be executed when an action from a friend is received. * Function format is: function(int32_t friendnumber, uint8_t * action, uint32_t length) */ void m_callback_action(Messenger *m, void (*function)(Messenger *m, int32_t, const uint8_t *, uint16_t, void *), void *userdata); /* Set the callback for name changes. * Function(int32_t friendnumber, uint8_t *newname, uint16_t length) * You are not responsible for freeing newname. */ void m_callback_namechange(Messenger *m, void (*function)(Messenger *m, int32_t, const uint8_t *, uint16_t, void *), void *userdata); /* Set the callback for status message changes. * Function(int32_t friendnumber, uint8_t *newstatus, uint16_t length) * * You are not responsible for freeing newstatus */ void m_callback_statusmessage(Messenger *m, void (*function)(Messenger *m, int32_t, const uint8_t *, uint16_t, void *), void *userdata); /* Set the callback for status type changes. * Function(int32_t friendnumber, USERSTATUS kind) */ void m_callback_userstatus(Messenger *m, void (*function)(Messenger *m, int32_t, uint8_t, void *), void *userdata); /* Set the callback for typing changes. * Function(int32_t friendnumber, uint8_t is_typing) */ void m_callback_typingchange(Messenger *m, void(*function)(Messenger *m, int32_t, uint8_t, void *), void *userdata); /* Set the callback for read receipts. * Function(int32_t friendnumber, uint32_t receipt) * * If you are keeping a record of returns from m_sendmessage, * receipt might be one of those values, meaning the message * has been received on the other side. * Since core doesn't track ids for you, receipt may not correspond to any message. * In that case, you should discard it. */ void m_callback_read_receipt(Messenger *m, void (*function)(Messenger *m, int32_t, uint32_t, void *), void *userdata); /* Set the callback for connection status changes. * function(int32_t friendnumber, uint8_t status) * * Status: * 0 -- friend went offline after being previously online. * 1 -- friend went online. * * Note that this callback is not called when adding friends, thus the "after * being previously online" part. * It's assumed that when adding friends, their connection status is offline. */ void m_callback_connectionstatus(Messenger *m, void (*function)(Messenger *m, int32_t, uint8_t, void *), void *userdata); /* Same as previous but for internal A/V core usage only */ void m_callback_connectionstatus_internal_av(Messenger *m, void (*function)(Messenger *m, int32_t, uint8_t, void *), void *userdata); /* Set the callback function for avatar information. * This callback will be called when avatar information are received from friends. These events * can arrive at anytime, but are usually received uppon connection and in reply of avatar * information requests. * * Function format is: * function(Tox *tox, int32_t friendnumber, uint8_t format, uint8_t *hash, void *userdata) * * where 'format' is the avatar image format (see AVATAR_FORMAT) and 'hash' is the hash of * the avatar data for caching purposes and it is exactly AVATAR_HASH_LENGTH long. If the * image format is NONE, the hash is zeroed. * */ void m_callback_avatar_info(Messenger *m, void (*function)(Messenger *m, int32_t, uint8_t, uint8_t *, void *), void *userdata); /* Set the callback function for avatar data. * This callback will be called when the complete avatar data was correctly received from a * friend. This only happens in reply of a avatar data request (see tox_request_avatar_data); * * Function format is: * function(Tox *tox, int32_t friendnumber, uint8_t format, uint8_t *hash, uint8_t *data, uint32_t datalen, void *userdata) * * where 'format' is the avatar image format (see AVATAR_FORMAT); 'hash' is the * locally-calculated cryptographic hash of the avatar data and it is exactly * AVATAR_HASH_LENGTH long; 'data' is the avatar image data and 'datalen' is the length * of such data. * * If format is NONE, 'data' is NULL, 'datalen' is zero, and the hash is zeroed. The hash is * always validated locally with the function tox_avatar_hash and ensured to match the image * data, so this value can be safely used to compare with cached avatars. * * WARNING: users MUST treat all avatar image data received from another peer as untrusted and * potentially malicious. The library only ensures that the data which arrived is the same the * other user sent, and does not interpret or validate any image data. */ void m_callback_avatar_data(Messenger *m, void (*function)(Messenger *m, int32_t, uint8_t, uint8_t *, uint8_t *, uint32_t, void *), void *userdata); /**********GROUP CHATS************/ /* Set the callback for group invites. * * Function(Messenger *m, int32_t friendnumber, uint8_t *data, uint16_t length) */ void m_callback_group_invite(Messenger *m, void (*function)(Messenger *m, int32_t, const uint8_t *, uint16_t)); /* Send a group invite packet. * * return 1 on success * return 0 on failure */ int send_group_invite_packet(const Messenger *m, int32_t friendnumber, const uint8_t *data, uint16_t length); /****************FILE SENDING*****************/ /* Set the callback for file send requests. * * Function(Tox *tox, int32_t friendnumber, uint8_t filenumber, uint64_t filesize, uint8_t *filename, uint16_t filename_length, void *userdata) */ void callback_file_sendrequest(Messenger *m, void (*function)(Messenger *m, int32_t, uint8_t, uint64_t, const uint8_t *, uint16_t, void *), void *userdata); /* Set the callback for file control requests. * * Function(Tox *tox, int32_t friendnumber, uint8_t send_receive, uint8_t filenumber, uint8_t control_type, uint8_t *data, uint16_t length, void *userdata) * */ void callback_file_control(Messenger *m, void (*function)(Messenger *m, int32_t, uint8_t, uint8_t, uint8_t, const uint8_t *, uint16_t, void *), void *userdata); /* Set the callback for file data. * * Function(Tox *tox, int32_t friendnumber, uint8_t filenumber, uint8_t *data, uint16_t length, void *userdata) * */ void callback_file_data(Messenger *m, void (*function)(Messenger *m, int32_t, uint8_t, const uint8_t *, uint16_t length, void *), void *userdata); /* Send a file send request. * Maximum filename length is 255 bytes. * return 1 on success * return 0 on failure */ int file_sendrequest(const Messenger *m, int32_t friendnumber, uint8_t filenumber, uint64_t filesize, const uint8_t *filename, uint16_t filename_length); /* Send a file send request. * Maximum filename length is 255 bytes. * return file number on success * return -1 on failure */ int new_filesender(const Messenger *m, int32_t friendnumber, uint64_t filesize, const uint8_t *filename, uint16_t filename_length); /* Send a file control request. * send_receive is 0 if we want the control packet to target a sending file, 1 if it targets a receiving file. * * return 1 on success * return 0 on failure */ int file_control(const Messenger *m, int32_t friendnumber, uint8_t send_receive, uint8_t filenumber, uint8_t message_id, const uint8_t *data, uint16_t length); /* Send file data. * * return 1 on success * return 0 on failure */ int file_data(const Messenger *m, int32_t friendnumber, uint8_t filenumber, const uint8_t *data, uint16_t length); /* Give the number of bytes left to be sent/received. * * send_receive is 0 if we want the sending files, 1 if we want the receiving. * * return number of bytes remaining to be sent/received on success * return 0 on failure */ uint64_t file_dataremaining(const Messenger *m, int32_t friendnumber, uint8_t filenumber, uint8_t send_receive); /*************** A/V related ******************/ /* Set the callback for msi packets. * * Function(Messenger *m, int32_t friendnumber, uint8_t *data, uint16_t length, void *userdata) */ void m_callback_msi_packet(Messenger *m, void (*function)(Messenger *m, int32_t, const uint8_t *, uint16_t, void *), void *userdata); /* Send an msi packet. * * return 1 on success * return 0 on failure */ int m_msi_packet(const Messenger *m, int32_t friendnumber, const uint8_t *data, uint16_t length); /**********************************************/ /* Set handlers for custom lossy packets (RTP packets for example.) * * return -1 on failure. * return 0 on success. */ int custom_lossy_packet_registerhandler(Messenger *m, int32_t friendnumber, uint8_t byte, int (*packet_handler_callback)(Messenger *m, int32_t friendnumber, const uint8_t *data, uint32_t len, void *object), void *object); /* High level function to send custom lossy packets. * * return -1 on failure. * return 0 on success. */ int send_custom_lossy_packet(const Messenger *m, int32_t friendnumber, const uint8_t *data, uint32_t length); /* Set handlers for custom lossless packets. * * byte must be in PACKET_ID_LOSSLESS_RANGE_START PACKET_ID_LOSSLESS_RANGE_SIZE range. * * return -1 on failure. * return 0 on success. */ int custom_lossless_packet_registerhandler(Messenger *m, int32_t friendnumber, uint8_t byte, int (*packet_handler_callback)(Messenger *m, int32_t friendnumber, const uint8_t *data, uint32_t len, void *object), void *object); /* High level function to send custom lossless packets. * * return -1 on failure. * return 0 on success. */ int send_custom_lossless_packet(const Messenger *m, int32_t friendnumber, const uint8_t *data, uint32_t length); /**********************************************/ /* Run this at startup. * return allocated instance of Messenger on success. * return 0 if there are problems. */ Messenger *new_messenger(Messenger_Options *options); /* Run this before closing shop * Free all datastructures. */ void kill_messenger(Messenger *m); /* The main loop that needs to be run at least 20 times per second. */ void do_messenger(Messenger *m); /* Return the time in milliseconds before do_messenger() should be called again * for optimal performance. * * returns time (in ms) before the next do_messenger() needs to be run on success. */ uint32_t messenger_run_interval(Messenger *m); /* SAVING AND LOADING FUNCTIONS: */ /* return size of the messenger data (for saving). */ uint32_t messenger_size(const Messenger *m); /* Save the messenger in data (must be allocated memory of size Messenger_size()) */ void messenger_save(const Messenger *m, uint8_t *data); /* Load the messenger from data of size length. */ int messenger_load(Messenger *m, const uint8_t *data, uint32_t length); /* Return the number of friends in the instance m. * You should use this to determine how much memory to allocate * for copy_friendlist. */ uint32_t count_friendlist(const Messenger *m); /* Return the number of online friends in the instance m. */ uint32_t get_num_online_friends(const Messenger *m); /* Copy a list of valid friend IDs into the array out_list. * If out_list is NULL, returns 0. * Otherwise, returns the number of elements copied. * If the array was too small, the contents * of out_list will be truncated to list_size. */ uint32_t copy_friendlist(const Messenger *m, int32_t *out_list, uint32_t list_size); #endif