/*
This file is part of GNUnet.
Copyright (C) 2021--2022 GNUnet e.V.
GNUnet is free software: you can redistribute it and/or modify it
under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License,
or (at your option) any later version.
GNUnet 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
Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see .
SPDX-License-Identifier: AGPL3.0-or-later
*/
/*
* @author Tobias Frisch
* @file gnunet_chat_handle.h
*/
#ifndef GNUNET_CHAT_HANDLE_H_
#define GNUNET_CHAT_HANDLE_H_
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include "gnunet_chat_lib.h"
#include "gnunet_chat_account.h"
#include "gnunet_chat_lobby.h"
#include "gnunet_chat_message.h"
#include "gnunet_chat_uri.h"
struct GNUNET_CHAT_Handle;
struct GNUNET_CHAT_InternalMessages
{
struct GNUNET_CHAT_Message *msg;
struct GNUNET_CHAT_InternalMessages *next;
struct GNUNET_CHAT_InternalMessages *prev;
};
struct GNUNET_CHAT_InternalAccounts
{
struct GNUNET_CHAT_Account *account;
struct GNUNET_CHAT_Handle *handle;
struct GNUNET_IDENTITY_Operation *op;
struct GNUNET_CHAT_InternalAccounts *next;
struct GNUNET_CHAT_InternalAccounts *prev;
};
struct GNUNET_CHAT_InternalLobbies
{
struct GNUNET_CHAT_Lobby *lobby;
struct GNUNET_CHAT_InternalLobbies *next;
struct GNUNET_CHAT_InternalLobbies *prev;
};
struct GNUNET_CHAT_UriLookups
{
struct GNUNET_CHAT_Handle *handle;
struct GNUNET_GNS_LookupRequest *request;
struct GNUNET_CHAT_Uri *uri;
struct GNUNET_CHAT_UriLookups *next;
struct GNUNET_CHAT_UriLookups *prev;
};
struct GNUNET_CHAT_Handle
{
const struct GNUNET_CONFIGURATION_Handle* cfg;
struct GNUNET_SCHEDULER_Task *shutdown_hook;
struct GNUNET_SCHEDULER_Task *destruction;
struct GNUNET_CHAT_InternalMessages *internal_head;
struct GNUNET_CHAT_InternalMessages *internal_tail;
char *directory;
GNUNET_CHAT_ContextMessageCallback msg_cb;
void *msg_cls;
struct GNUNET_CHAT_InternalAccounts *accounts_head;
struct GNUNET_CHAT_InternalAccounts *accounts_tail;
const struct GNUNET_CHAT_Account *current;
struct GNUNET_NAMESTORE_ZoneMonitor *monitor;
struct GNUNET_CHAT_InternalLobbies *lobbies_head;
struct GNUNET_CHAT_InternalLobbies *lobbies_tail;
struct GNUNET_CHAT_UriLookups *lookups_head;
struct GNUNET_CHAT_UriLookups *lookups_tail;
struct GNUNET_CONTAINER_MultiHashMap *files;
struct GNUNET_CONTAINER_MultiHashMap *contexts;
struct GNUNET_CONTAINER_MultiShortmap *contacts;
struct GNUNET_CONTAINER_MultiHashMap *groups;
struct GNUNET_ARM_Handle *arm;
struct GNUNET_FS_Handle *fs;
struct GNUNET_GNS_Handle *gns;
struct GNUNET_IDENTITY_Handle *identity;
struct GNUNET_MESSENGER_Handle *messenger;
struct GNUNET_NAMESTORE_Handle *namestore;
char *public_key;
void *user_pointer;
};
/**
* Creates a chat handle with a selected configuration,
* a custom message callback and a custom closure for
* the callback.
*
* @param[in] cfg Configuration
* @param[in] msg_cb Message callback
* @param[in,out] msg_cls Closure
* @return New chat handle
*/
struct GNUNET_CHAT_Handle*
handle_create_from_config (const struct GNUNET_CONFIGURATION_Handle* cfg,
GNUNET_CHAT_ContextMessageCallback msg_cb,
void *msg_cls);
/**
* Updates the string representation of the public key from
* a given chat handle.
*
* @param[in,out] handle Chat handle
*/
void
handle_update_key (struct GNUNET_CHAT_Handle *handle);
/**
* Destroys a chat handle and frees its memory.
*
* @param[in,out] handle Chat handle
*/
void
handle_destroy (struct GNUNET_CHAT_Handle *handle);
/**
* Connects a given chat handle to a selected
* chat account using it for further operations.
*
* @param[in,out] handle Chat handle
* @param[in] account Chat account
*/
void
handle_connect (struct GNUNET_CHAT_Handle *handle,
const struct GNUNET_CHAT_Account *account);
/**
* Disconnects a given chat handle from its current
* connected chat account.
*
* @param[in,out] handle Chat handle
*/
void
handle_disconnect (struct GNUNET_CHAT_Handle *handle);
/**
* Returns the main directory path to store information
* of a given chat handle.
*
* @param[in] handle Chat handle
* @return Directory path
*/
const char*
handle_get_directory (const struct GNUNET_CHAT_Handle *handle);
/**
* Returns the private key from the current connected chat
* account of a given chat handle.
*
* @param[in] handle Chat handle
* @return EGOs private key or NULL
*/
const struct GNUNET_IDENTITY_PrivateKey*
handle_get_key (const struct GNUNET_CHAT_Handle *handle);
/**
* Sends an internal chat message from a given chat
* handle with an optional chat context,
* a custom flag and an optional warning text.
*
* @param[in,out] handle Chat handle
* @param[in,out] context Chat context or NULL
* @param[in] flag Chat message flag
* @param[in] warning Warning text
*/
void
handle_send_internal_message (struct GNUNET_CHAT_Handle *handle,
struct GNUNET_CHAT_Context *context,
enum GNUNET_CHAT_MessageFlag flag,
const char *warning);
/**
* Sends a name message to a messenger room with
* a selected chat handle.
*
* @param[in,out] handle Chat handle
* @param[in,out] room Messenger room
*/
void
handle_send_room_name (struct GNUNET_CHAT_Handle *handle,
struct GNUNET_MESSENGER_Room *room);
/**
* Checks a given chat handle for any chat context
* connected with a messenger room, creates it if
* necessary and manages its context type.
*
* @param[in,out] handle Chat handle
* @param[in,out] room Messenger room
* @return #GNUNET_OK on success, otherwise #GNUNET_SYSERR
*/
int
handle_request_context_by_room (struct GNUNET_CHAT_Handle *handle,
struct GNUNET_MESSENGER_Room *room);
/**
* Returns the chat contact registered for a given messenger
* contact by a selected chat handle.
*
* @param[in] handle Chat handle
* @param[in] contact Messenger contact
* @return Chat contact or NULL
*/
struct GNUNET_CHAT_Contact*
handle_get_contact_from_messenger (const struct GNUNET_CHAT_Handle *handle,
const struct GNUNET_MESSENGER_Contact *contact);
/**
* Returns the chat group registered for a given messenger
* room by a selected chat handle.
*
* @param[in] handle Chat handle
* @param[in] room Messenger room
* @return Chat group or NULL
*/
struct GNUNET_CHAT_Group*
handle_get_group_from_messenger (const struct GNUNET_CHAT_Handle *handle,
const struct GNUNET_MESSENGER_Room *room);
/**
* Processes the data of records under a given
* label and creates a matching chat context
* with it if it does not exist already, registered by a chat
* handle, to be updated.
*
* @param[in,out] handle Chat handle
* @param[in] label Namestore label
* @param[in] count Count of data
* @param[in] data Records data
* @return Chat context or NULL
*/
struct GNUNET_CHAT_Context*
handle_process_records (struct GNUNET_CHAT_Handle *handle,
const char *label,
unsigned int count,
const struct GNUNET_GNSRECORD_Data *data);
#endif /* GNUNET_CHAT_HANDLE_H_ */