aboutsummaryrefslogtreecommitdiff
path: root/src/gnunet_chat_message.h
blob: bba251ca070855cac1e1f9a49f625c603557c1fe (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
/*
   This file is part of GNUnet.
   Copyright (C) 2021--2024 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 <http://www.gnu.org/licenses/>.

   SPDX-License-Identifier: AGPL3.0-or-later
 */
/*
 * @author Tobias Frisch
 * @file gnunet_chat_message.h
 */

#ifndef GNUNET_CHAT_MESSAGE_H_
#define GNUNET_CHAT_MESSAGE_H_

#include <gnunet/gnunet_common.h>
#include <gnunet/gnunet_messenger_service.h>
#include <gnunet/gnunet_util_lib.h>

struct GNUNET_CHAT_Context;
struct GNUNET_CHAT_Message;

struct GNUNET_CHAT_MessageList
{
  struct GNUNET_CHAT_Message *message;

  struct GNUNET_CHAT_MessageList *prev;
  struct GNUNET_CHAT_MessageList *next;
};

enum GNUNET_CHAT_MessageFlag
{
  GNUNET_CHAT_FLAG_NONE = 0,
  GNUNET_CHAT_FLAG_WARNING = 1,
  GNUNET_CHAT_FLAG_REFRESH = 2,
  GNUNET_CHAT_FLAG_LOGIN = 3,
  GNUNET_CHAT_FLAG_LOGOUT = 4,
  GNUNET_CHAT_FLAG_CREATE_ACCOUNT = 5,
  GNUNET_CHAT_FLAG_DELETE_ACCOUNT = 6,
  GNUNET_CHAT_FLAG_UPDATE_ACCOUNT = 7,
  GNUNET_CHAT_FLAG_UPDATE_CONTEXT = 8,
  GNUNET_CHAT_FLAG_ATTRIBUTES = 9,
  GNUNET_CHAT_FLAG_SHARE_ATTRIBUTES = 10
};

struct GNUNET_CHAT_Message
{
  const struct GNUNET_CHAT_Account *account;

  struct GNUNET_CHAT_Context *context;
  struct GNUNET_SCHEDULER_Task *task;

  union {
    const struct GNUNET_MESSENGER_Message *msg;
    const char *warning;
    const char *attr;
  };

  struct GNUNET_HashCode hash;
  enum GNUNET_MESSENGER_MessageFlags flags;
  enum GNUNET_CHAT_MessageFlag flag;
};

/**
 * Creates a chat message representing an actual message
 * from the messenger service in a given chat <i>context</i>
 * with a valid <i>hash</i> and message <i>flags</i>
 *
 * @param[in,out] context Chat context
 * @param[in] hash Message hash
 * @param[in] flags Message flags
 * @param[in] msg Messenger message
 * @return New chat message
 */
struct GNUNET_CHAT_Message*
message_create_from_msg (struct GNUNET_CHAT_Context *context,
                         const struct GNUNET_HashCode *hash,
                         enum GNUNET_MESSENGER_MessageFlags flags,
                         const struct GNUNET_MESSENGER_Message *msg);

/**
 * Creates an internal chat message with an optional chat
 * <i>account</i> or <i>context</i>, a custom <i>flag</i> 
 * and an optional <i>warning</i> text.
 *
 * @param[in] account Chat account or NULL
 * @param[in,out] context Chat context or NULL
 * @param[in] flag Chat message flag
 * @param[in] warning Warning text
 * @return New internal chat message
 */
struct GNUNET_CHAT_Message*
message_create_internally (const struct GNUNET_CHAT_Account *account,
                           struct GNUNET_CHAT_Context *context,
                           enum GNUNET_CHAT_MessageFlag flag,
                           const char *warning);

/**
 * Returns whether a chat <i>message</i> contains an actual
 * message from the messenger service.
 *
 * @param[in] message Chat message
 * @return #GNUNET_YES if it contains message content, #GNUNET_NO otherwise
 */
enum GNUNET_GenericReturnValue
message_has_msg (const struct GNUNET_CHAT_Message* message);

/**
 * Updates a chat message representing an actual message
 * from the messenger service.
 *
 * @param[in,out] message Chat message
 * @param[in] flags Message flags
 * @param[in] msg Messenger message
 */
void
message_update_msg (struct GNUNET_CHAT_Message* message,
                    enum GNUNET_MESSENGER_MessageFlags flags,
                    const struct GNUNET_MESSENGER_Message *msg);

/**
 * Destroys a chat <i>message</i> and frees its memory.
 *
 * @param[in,out] message Chat message
 */
void
message_destroy (struct GNUNET_CHAT_Message* message);

#endif /* GNUNET_CHAT_MESSAGE_H_ */