/usr/include/licq/icq/chat.h is in licq-dev 1.6.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 | /*
* This file is part of Licq, an instant messaging client for UNIX.
* Copyright (C) 2000-2011 Licq developers
*
* Licq 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 2 of the License, or
* (at your option) any later version.
*
* Licq 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 Licq; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef LICQ_ICQCHAT_H
#define LICQ_ICQCHAT_H
#include <cstdlib>
#include <deque>
#include <list>
#include <string>
#include <licq/pipe.h>
#include <licq/socket.h>
#include <licq/socketmanager.h>
namespace Licq
{
class User;
class UserId;
}
/*----------------------
* Licq Chat Module
*
* ICQ Chat is fairly easy to implement using the Licq ChatManager.
* There are three parts, initiating a chat, accepting a chat, and
* managing a chat in session.
* 1. Initiating
*
* <to be filled in later>
*
*
* 2. Accepting
*
* < to be filled in later>
*
*
* 3. Managing
*
* Once the plugin has created whatever chat dialog it needs, the following
* steps should be performed to start the actual chat session:
* a) Create a new instance of CChatManager. This class encapsulates
* all the necessary handshaking and packet processing to both connect
* to and receive chat clients.
* The class takes as arguments a pointer to the licq daemon, the Uin
* we are first connecting to or first receiving a connection from,
* and the initial GUI settings (colors, font).
* b) Attach to the chat manager pipe. The ChatManager contains a function
* Pipe() which will return a socket to listen on for messages. When
* something interesting happens during the chat (a new user connects,
* a user disconnects, a user changes colors, a user types a
* character...) a single byte is written to this socket and the relevant
* CChatEvent is pushed onto the Chat Event queue. Hence if there is
* data to be read on the Pipe(), then pop it off (it can be ignored) and
* then call CChatManager::PopChatEvent() which will return the
* CChatEvent. This is just like the plugin pipe used to send messages
* from the daemon to the plugin.
* c) Call either CChatManager::StartAsServer() or
* CChatManager::StartAsClient(<port>) to tell the chat manager to start
* doing stuff.
*
* Now it is just a matter of waiting on the Pipe() until an event occurs,
* which will be an event of type CHAT_CONNECTION indicating that a new
* user has joined the chat. Writing to the chat session is done by
* calling any of the CChatManager::Send<...> functions (such as
* SendCharacter(char)).
*
* When a user types a newline, the CHAT_NEWLINE
* event is sent, and the CChatEvent::Data() element will contain the entire
* past line of text typed. This can be used to implement IRC mode
* efficiently (note that since each character is also passed to the plugin
* as it is typed, the line sent in a CHAT_NEWLINE event is composed
* of duplicate characters). For a CHAT_CHARACTER event, the
* CChatEvent::Data() field contains the character typed. For all other
* events the Data() field will be NULL.
*
* When a user requests to kick another user, the CHAT_KICK event is sent,
* and then the CChatUser::ToKick() contains the uin of the person to kick.
* The plugin shall then call CChatManager::SendVoteNo() or
* CChatManager::SendVoteYes(). Both functions take the UIN of the user we
* are voting on.
*
* If you want to kick someone, just simply call CChatManager::SendKick().
* The single parameter is the UIN of the user to collect a vote on. After
* a majority is collected, or a tie, the daemon will send out everything that
* is necessary.
*
* When a user is kicked out of a room, the CHAT_DISCONNECTIONxKICKED
* event is sent.
*
* Call CChatManager::CloseChat() when finished with the chat. Note that
* this will generate a number of CHAT_DISCONNECTION events as each client
* is disconnected from the chat.
*
*--------------------------------------------------------------------------*/
// Chat event types
const unsigned char CHAT_COLORxFG = 0x00;
const unsigned char CHAT_COLORxBG = 0x01;
const unsigned char CHAT_KICK = 0x02;
const unsigned char CHAT_FOCUSxIN = 0x03;
const unsigned char CHAT_FOCUSxOUT = 0x04;
const unsigned char CHAT_KICKxYES = 0x05;
const unsigned char CHAT_KICKxNO = 0x06;
const unsigned char CHAT_BEEP = 0x07;
const unsigned char CHAT_BACKSPACE = 0x08;
const unsigned char CHAT_KICKxPASS = 0x09;
const unsigned char CHAT_DISCONNECTION = 0x0B;
const unsigned char CHAT_DISCONNECTIONxKICKED = 0x0C;
const unsigned char CHAT_NEWLINE = 0x0D;
const unsigned char CHAT_KICKxYOU = 0x0E;
const unsigned char CHAT_KICKxFAIL = 0x0F;
const unsigned char CHAT_FONTxFAMILY = 0x10;
const unsigned char CHAT_FONTxFACE = 0x11;
const unsigned char CHAT_FONTxSIZE = 0x12;
const unsigned char CHAT_SLEEPxOFF = 0x16;
const unsigned char CHAT_SLEEPxON = 0x17;
const unsigned char CHAT_LAUGH = 0x1A;
const unsigned char CHAT_CHARACTER = 0x7E;
const unsigned char CHAT_CONNECTION = 0x7F;
const unsigned char CHAT_ERRORxCONNECT = 0xFF;
const unsigned char CHAT_ERRORxBIND = 0xFE;
const unsigned char CHAT_ERRORxRESOURCES = 0xFD;
// Font contants (should not need to be used by the plugin)
const unsigned long FONT_PLAIN = 0x00000000;
const unsigned long FONT_BOLD = 0x00000001;
const unsigned long FONT_ITALIC = 0x00000002;
const unsigned long FONT_UNDERLINE = 0x00000004;
const unsigned long FONT_STRIKEOUT = 0x00000008;
//Font encodings (taken from windows api docs)
const unsigned char ENCODING_ANSI = 0;
const unsigned char ENCODING_DEFAULT = 1;
const unsigned char ENCODING_SYMBOL = 2;
const unsigned char ENCODING_MAC = 77;
const unsigned char ENCODING_SHIFTJIS = 128;
const unsigned char ENCODING_HANGEUL = 129;
const unsigned char ENCODING_JOHAB = 130;
const unsigned char ENCODING_GB2312 = 134;
const unsigned char ENCODING_CHINESEBIG5 = 136;
const unsigned char ENCODING_GREEK = 161;
const unsigned char ENCODING_TURKISH = 162;
const unsigned char ENCODING_VIETNAMESE = 163;
const unsigned char ENCODING_HEBREW = 177;
const unsigned char ENCODING_ARABIC = 178;
const unsigned char ENCODING_BALTIC = 186;
const unsigned char ENCODING_RUSSIAN = 204;
const unsigned char ENCODING_THAI = 222;
const unsigned char ENCODING_EASTEUROPE = 238;
const unsigned char ENCODING_OEM = 255;
//Font style (taken from windows api docs)
const unsigned char STYLE_DEFAULTxPITCH = 0x00;
const unsigned char STYLE_FIXEDxPITCH = 0x01;
const unsigned char STYLE_VARIABLExPITCH = 0x02;
const unsigned char STYLE_DONTCARE = 0x00;
const unsigned char STYLE_ROMAN = 0x10;
const unsigned char STYLE_SWISS = 0x20;
const unsigned char STYLE_MODERN = 0x30;
const unsigned char STYLE_SCRIPT = 0x40;
const unsigned char STYLE_DECORATIVE = 0x50;
struct SVoteInfo
{
unsigned long nUin;
unsigned short nNumUsers;
unsigned short nYes;
unsigned short nNo;
};
typedef std::list<SVoteInfo *> VoteInfoList;
class CChatUser;
class CChatManager;
struct SChatReverseConnectInfo
{
int nId;
bool bTryDirect;
CChatUser *u;
CChatManager *m;
};
//-----ChatColorFont------------------------------------------------------------
class CChatClient
{
public:
CChatClient();
CChatClient(const Licq::User* u);
CChatClient(const CChatClient &);
CChatClient& operator=(const CChatClient &);
~CChatClient();
// Initialize from the handshake buffer (does not set the session
// or port fields however)
bool LoadFromHandshake_v2(Licq::Buffer&);
bool LoadFromHandshake_v4(Licq::Buffer&);
bool LoadFromHandshake_v6(Licq::Buffer&);
bool LoadFromHandshake_v7(Licq::Buffer&);
unsigned long m_nVersion;
unsigned short m_nPort;
Licq::UserId myUserId;
unsigned long m_nIp;
unsigned long m_nIntIp;
char m_nMode;
unsigned short m_nSession;
unsigned long m_nHandshake;
unsigned short m_nId;
protected:
CChatClient(Licq::Buffer&);
bool LoadFromBuffer(Licq::Buffer&);
friend class CPChat_ColorFont;
};
typedef std::list<CChatClient> ChatClientList;
typedef std::list<CChatClient *> ChatClientPList;
//=====CChatUser=============================================================
extern "C"
{
void *ChatManager_tep(void *);
void *ChatWaitForSignal_tep(void *);
void ChatWaitForSignal_cleanup(void *);
}
class CChatUser
{
public:
const Licq::UserId& userId() const { return myUserId; }
unsigned long ToKick() { return nToKick; }
const std::string& name() const { return myName; }
int *ColorFg() { return colorFore; }
int *ColorBg() { return colorBack; }
const std::string& fontFamily() const { return myFontFamily; }
unsigned char FontEncoding() { return fontEncoding; }
unsigned char FontStyle() { return fontStyle; }
unsigned short FontSize() { return fontSize; }
bool FontBold() { return fontFace & FONT_BOLD; }
bool FontItalic() { return fontFace & FONT_ITALIC; }
bool FontUnderline() { return fontFace & FONT_UNDERLINE; }
bool FontStrikeOut() { return fontFace & FONT_STRIKEOUT; }
bool Focus() { return focus; }
bool Sleep() { return sleep; }
~CChatUser();
protected:
CChatUser();
Licq::UserId myUserId;
unsigned long nToKick;
std::string myName;
int colorFore[3], colorBack[3];
std::string myFontFamily;
unsigned char fontEncoding, fontStyle;
unsigned short fontSize;
unsigned long fontFace;
bool focus, sleep;
CChatClient *m_pClient;
Licq::TCPSocket sock;
std::deque <unsigned char> chatQueue;
unsigned short state;
std::string myLinebuf;
pthread_mutex_t mutex;
friend class CChatManager;
friend class CChatEvent;
friend void *ChatManager_tep(void *);
friend void *ChatWaitForSignal_tep(void *);
friend void ChatWaitForSignal_cleanup(void *);
};
typedef std::list<CChatUser *> ChatUserList;
//=====ChatEvent=============================================================
class CChatEvent
{
public:
CChatEvent(unsigned char, CChatUser *, const std::string& data = "");
~CChatEvent();
unsigned char Command() { return m_nCommand; }
CChatUser *Client() { return m_pUser; }
const std::string& data() const { return myData; }
protected:
unsigned char m_nCommand;
CChatUser *m_pUser;
std::string myData;
bool m_bLocked;
friend class CChatManager;
};
typedef std::list <CChatEvent *> ChatEventList;
//=====ChatManager===========================================================
typedef std::list<class CChatManager *> ChatManagerList;
typedef std::list<pthread_t> ThreadList;
class CChatManager
{
public:
CChatManager(unsigned long nUin,
const std::string& fontFamily = "courier",
unsigned char fontEncoding = ENCODING_DEFAULT,
unsigned char fontStyle = STYLE_DONTCARE | STYLE_DEFAULTxPITCH,
unsigned short fontSize = 12, bool fontBold = false,
bool fontItalic = false, bool fontUnderline = false,
bool fontStrikeOut = false, int fr = 0xFF, int fg = 0xFF,
int fb = 0xFF, int br = 0x00, int bg = 0x00, int bb = 0x00);
~CChatManager();
bool StartAsServer();
void StartAsClient(unsigned short nPort);
void CloseChat();
std::string clientsString() const;
unsigned short ConnectedUsers() { return chatUsers.size(); }
uint16_t LocalPort() const { return chatServer.getLocalPort(); }
const std::string& name() const { return myName; }
const std::string& fontFamily() const { return myFontFamily; }
unsigned char FontEncoding() { return m_nFontEncoding; }
unsigned char FontStyle() { return m_nFontStyle; }
unsigned long FontFace() { return m_nFontFace; }
unsigned short FontSize() { return m_nFontSize; }
int *ColorFg() { return m_nColorFore; }
int *ColorBg() { return m_nColorBack; }
bool Sleep() { return m_bSleep; }
bool Focus() { return m_bFocus; }
void changeFontFamily(const std::string& fontFamily, unsigned char, unsigned char);
void ChangeFontSize(unsigned short);
void ChangeFontFace(bool, bool, bool, bool);
void ChangeColorFg(int, int, int);
void ChangeColorBg(int, int, int);
void SendBeep();
void SendLaugh();
void SendNewline();
void SendBackspace();
void SendCharacter(char);
void SendKick(const char* id);
void SendKickNoVote(const char* id);
void SendVoteYes(unsigned long);
void SendVoteNo(unsigned long);
void FocusOut();
void FocusIn();
void Sleep(bool);
int Pipe() { return myEventsPipe.getReadFd(); }
CChatEvent *PopChatEvent();
void AcceptReverseConnection(Licq::TCPSocket*);
static CChatManager *FindByPort(unsigned short);
protected:
static ChatManagerList cmList;
static pthread_mutex_t cmList_mutex;
static pthread_mutex_t waiting_thread_cancel_mutex;
Licq::Pipe myEventsPipe;
Licq::Pipe myThreadPipe;
Licq::UserId myUserId;
unsigned short m_nSession;
ChatUserList chatUsers;
ChatUserList chatUsersClosed;
ChatEventList chatEvents;
VoteInfoList voteInfo;
ThreadList waitingThreads;
pthread_mutex_t thread_list_mutex;
pthread_t thread_chat;
CChatClient *m_pChatClient;
int m_nColorFore[3], m_nColorBack[3];
std::string myName;
std::string myFontFamily;
unsigned char m_nFontEncoding, m_nFontStyle;
unsigned short m_nFontSize;
unsigned long m_nFontFace;
bool m_bSleep, m_bFocus;
Licq::TCPSocket chatServer;
Licq::SocketManager sockman;
bool m_bThreadCreated;
bool StartChatServer();
bool ConnectToChat(CChatClient *);
bool SendChatHandshake(CChatUser *);
CChatUser *FindChatUser(int);
void CloseClient(CChatUser *);
bool ProcessPacket(CChatUser *);
bool ProcessRaw(CChatUser *);
bool ProcessRaw_v2(CChatUser *);
bool ProcessRaw_v6(CChatUser *);
void PushChatEvent(CChatEvent *);
void FinishKickVote(VoteInfoList::iterator, bool);
void SendBuffer(Licq::Buffer*, unsigned char,
const char* id = NULL, bool bNotIter = true);
bool SendBufferToClient(Licq::Buffer*, unsigned char, CChatUser *);
void SendBuffer_Raw(Licq::Buffer*);
//void SendPacket(Licq::Packet*);
friend void *ChatManager_tep(void *);
friend void *ChatWaitForSignal_tep(void *);
friend void ChatWaitForSignal_cleanup(void *);
};
#endif
|