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
|
#ifndef _MODULES_H
#define _MODULES_H
#include "main.h"
#include "FileUtils.h"
#include "Client.h"
#include <dlfcn.h>
#include <vector>
#include <set>
using std::vector;
using std::set;
// User Module Macros
#ifdef REQUIRESSL
#ifndef HAVE_LIBSSL
#error -
#error -
#error This module only works when znc is compiled with OpenSSL support
#error -
#error -
#endif
#endif
#define MODCONSTRUCTOR(CLASS) \
CLASS(void *pDLL, CUser* pUser, const CString& sModName) : CModule(pDLL, pUser, sModName)
#define MODULEDEFS(CLASS, DESCRIPTION) \
extern "C" { \
CString GetDescription() { return DESCRIPTION; } \
bool IsGlobal() { return false; } \
CModule* Load(void* p, CUser* pUser, const CString& sModName); \
void Unload(CModule* pMod); double GetVersion(); } \
double GetVersion() { return VERSION; } \
CModule* Load(void* p, CUser* pUser, const CString& sModName) { return new CLASS(p, pUser, sModName); } \
void Unload(CModule* pMod) { if (pMod) { delete pMod; } \
}
// !User Module Macros
// Global Module Macros
#define GLOBALMODCONSTRUCTOR(CLASS) \
CLASS(void *pDLL, const CString& sModName) : CGlobalModule(pDLL, sModName)
#define GLOBALMODULEDEFS(CLASS, DESCRIPTION) \
extern "C" { \
CString GetDescription() { return DESCRIPTION; } \
bool IsGlobal() { return true; } \
CGlobalModule* Load(void* p, const CString& sModName); \
void Unload(CGlobalModule* pMod); double GetVersion(); } \
double GetVersion() { return VERSION; } \
CGlobalModule* Load(void* p, const CString& sModName) { return new CLASS(p, sModName); } \
void Unload(CGlobalModule* pMod) { if (pMod) { delete pMod; } \
}
// !Global Module Macros
//const char* GetDescription() { static char sz[] = DESCRIPTION; return sz; }
// Forward Declarations
class CZNC;
class CUser;
class CNick;
class CChan;
class Csock;
class CModule;
class CFPTimer;
class CSockManager;
// !Forward Declarations
class CTimer : public CCron {
public:
CTimer(CModule* pModule, unsigned int uInterval, unsigned int uCycles, const CString& sLabel, const CString& sDescription);
virtual ~CTimer();
// Setters
void SetModule(CModule* p);
void SetDescription(const CString& s);
// !Setters
// Getters
CModule* GetModule() const;
const CString& GetDescription() const;
// !Getters
private:
protected:
CModule* m_pModule;
CString m_sDescription;
};
typedef void (*FPTimer_t)(CModule *, CFPTimer *);
class CFPTimer : public CTimer {
public:
CFPTimer(CModule* pModule, unsigned int uInterval, unsigned int uCycles, const CString& sLabel, const CString& sDescription)
: CTimer(pModule, uInterval, uCycles, sLabel, sDescription) {
m_pFBCallback = NULL;
}
virtual ~CFPTimer() {}
void SetFPCallback(FPTimer_t p) { m_pFBCallback = p; }
protected:
virtual void RunJob() {
if (m_pFBCallback) {
m_pFBCallback(m_pModule, this);
}
}
private:
FPTimer_t m_pFBCallback;
};
class CSocket : public Csock {
public:
CSocket(CModule* pModule, const CString& sLabel);
CSocket(CModule* pModule, const CString& sLabel, const CString& sHostname, unsigned short uPort, int iTimeout = 60);
virtual ~CSocket();
bool Connect(const CString& sHostname, unsigned short uPort, bool bSSL = false, unsigned int uTimeout = 60);
bool Listen(unsigned short uPort, bool bSSL = false, unsigned int uTimeout = 0);
virtual bool PutIRC(const CString& sLine);
virtual bool PutUser(const CString& sLine);
virtual bool PutStatus(const CString& sLine);
virtual bool PutModule(const CString& sLine, const CString& sIdent = "znc", const CString& sHost = "znc.com");
virtual bool PutModNotice(const CString& sLine, const CString& sIdent = "znc", const CString& sHost = "znc.com");
// Setters
void SetModule(CModule* p);
void SetLabel(const CString& s);
// !Setters
// Getters
CModule* GetModule() const;
const CString& GetLabel() const;
// !Getters
private:
protected:
CModule* m_pModule;
CString m_sLabel;
};
class CModInfo {
public:
CModInfo() {}
CModInfo(const CString& sName, const CString& sPath, bool bSystem, bool bGlobal) {
m_bSystem = bSystem;
m_bGlobal = bGlobal;
m_sName = sName;
m_sPath = sPath;
}
virtual ~CModInfo() {}
bool operator < (const CModInfo& Info) const {
return (GetName() < Info.GetName());
}
// Getters
const CString& GetName() const { return m_sName; }
const CString& GetPath() const { return m_sPath; }
const CString& GetDescription() const { return m_sDescription; }
bool IsSystem() const { return m_bSystem; }
bool IsGlobal() const { return m_bGlobal; }
// !Getters
// Setters
void SetName(const CString& s) { m_sName = s; }
void SetPath(const CString& s) { m_sPath = s; }
void SetDescription(const CString& s) { m_sDescription = s; }
void SetSystem(bool b) { m_bSystem = b; }
void SetGlobal(bool b) { m_bGlobal = b; }
// !Setters
private:
protected:
bool m_bSystem;
bool m_bGlobal;
CString m_sName;
CString m_sPath;
CString m_sDescription;
};
class CModule {
public:
CModule(void* pDLL, CUser* pUser, const CString& sModName);
CModule(void* pDLL, const CString& sModName);
virtual ~CModule();
typedef enum {
CONTINUE = 1,
HALT = 2,
HALTMODS = 3,
HALTCORE = 4
} EModRet;
typedef enum {
UNLOAD
} EModException;
void SetUser(CUser* pUser);
void SetClient(CClient* pClient);
void Unload();
virtual bool OnLoad(const CString& sArgs);
virtual bool OnBoot();
virtual void OnIRCDisconnected();
virtual void OnIRCConnected();
virtual EModRet OnBroadcast(CString& sMessage);
virtual EModRet OnDCCUserSend(const CNick& RemoteNick, unsigned long uLongIP, unsigned short uPort, const CString& sFile, unsigned long uFileSize);
virtual void OnChanPermission(const CNick& OpNick, const CNick& Nick, CChan& Channel, unsigned char uMode, bool bAdded, bool bNoChange);
virtual void OnOp(const CNick& OpNick, const CNick& Nick, CChan& Channel, bool bNoChange);
virtual void OnDeop(const CNick& OpNick, const CNick& Nick, CChan& Channel, bool bNoChange);
virtual void OnVoice(const CNick& OpNick, const CNick& Nick, CChan& Channel, bool bNoChange);
virtual void OnDevoice(const CNick& OpNick, const CNick& Nick, CChan& Channel, bool bNoChange);
virtual void OnRawMode(const CNick& OpNick, CChan& Channel, const CString& sModes, const CString& sArgs);
virtual EModRet OnRaw(CString& sLine);
virtual EModRet OnStatusCommand(const CString& sCommand);
virtual void OnModCommand(const CString& sCommand);
virtual void OnModNotice(const CString& sMessage);
virtual void OnModCTCP(const CString& sMessage);
virtual void OnQuit(const CNick& Nick, const CString& sMessage, const vector<CChan*>& vChans);
virtual void OnNick(const CNick& Nick, const CString& sNewNick, const vector<CChan*>& vChans);
virtual void OnKick(const CNick& Nick, const CString& sOpNick, CChan& Channel, const CString& sMessage);
virtual void OnJoin(const CNick& Nick, CChan& Channel);
virtual void OnPart(const CNick& Nick, CChan& Channel);
virtual void OnUserAttached();
virtual void OnUserDetached();
virtual EModRet OnUserRaw(CString& sLine);
virtual EModRet OnUserCTCPReply(CString& sTarget, CString& sMessage);
virtual EModRet OnUserCTCP(CString& sTarget, CString& sMessage);
virtual EModRet OnUserMsg(CString& sTarget, CString& sMessage);
virtual EModRet OnUserNotice(CString& sTarget, CString& sMessage);
virtual EModRet OnUserJoin(CString& sChannel, CString& sKey);
virtual EModRet OnUserPart(CString& sChannel, CString& sMessage);
virtual EModRet OnCTCPReply(CNick& Nick, CString& sMessage);
virtual EModRet OnPrivCTCP(CNick& Nick, CString& sMessage);
virtual EModRet OnChanCTCP(CNick& Nick, CChan& Channel, CString& sMessage);
virtual EModRet OnPrivMsg(CNick& Nick, CString& sMessage);
virtual EModRet OnChanMsg(CNick& Nick, CChan& Channel, CString& sMessage);
virtual EModRet OnPrivNotice(CNick& Nick, CString& sMessage);
virtual EModRet OnChanNotice(CNick& Nick, CChan& Channel, CString& sMessage);
void * GetDLL();
static double GetCoreVersion() { return VERSION; }
virtual bool PutIRC(const CString& sLine);
virtual bool PutUser(const CString& sLine);
virtual bool PutStatus(const CString& sLine);
virtual bool PutModule(const CString& sLine, const CString& sIdent = "znc", const CString& sHost = "znc.com");
virtual bool PutModNotice(const CString& sLine, const CString& sIdent = "znc", const CString& sHost = "znc.com");
const CString& GetModName() const;
CString GetModNick() const;
// Timer stuff
bool AddTimer(CTimer* pTimer);
bool AddTimer(FPTimer_t pFBCallback, const CString& sLabel, u_int uInterval, u_int uCycles = 0, const CString& sDescription = "");
bool RemTimer(const CString& sLabel);
bool UnlinkTimer(CTimer* pTimer);
CTimer* FindTimer(const CString& sLabel);
virtual void ListTimers();
// !Timer stuff
// Socket stuff
bool AddSocket(CSocket* pSocket);
bool RemSocket(CSocket* pSocket);
bool RemSocket(const CString& sLabel);
bool UnlinkSocket(CSocket* pSocket);
CSocket* FindSocket(const CString& sLabel);
virtual void ListSockets();
// !Socket stuff
bool LoadRegistry();
bool SaveRegistry();
bool SetNV(const CString & sName, const CString & sValue, bool bWriteToDisk = true);
CString GetNV(const CString & sName);
bool DelNV(const CString & sName, bool bWriteToDisk = true);
MCString::iterator FindNV(const CString & sName) { return m_mssRegistry.find(sName); }
MCString::iterator EndNV() { return m_mssRegistry.end(); }
MCString::iterator BeginNV() { return m_mssRegistry.begin(); }
void DelNV(MCString::iterator it) { m_mssRegistry.erase(it); }
const CString& GetSavePath() const { if (!CFile::Exists(m_sSavePath)) { CUtils::MakeDir(m_sSavePath); } return m_sSavePath; }
// Setters
void SetFake(bool b) { m_bFake = b; }
void SetDescription(const CString& s) { m_sDescription = s; }
void SetArgs(const CString& s) { m_sArgs = s; }
// !Setters
// Getters
bool IsFake() const { return m_bFake; }
const CString& GetDescription() const { return m_sDescription; }
const CString& GetArgs() const { return m_sArgs; }
CUser* GetUser() { return m_pUser; }
CClient* GetClient() { return m_pClient; }
CSockManager* GetManager() { return m_pManager; }
// !Getters
protected:
bool m_bFake;
CString m_sDescription;
vector<CTimer*> m_vTimers;
vector<CSocket*> m_vSockets;
void* m_pDLL;
CSockManager* m_pManager;
CUser* m_pUser;
CClient* m_pClient;
CString m_sModName;
CString m_sSavePath;
CString m_sArgs;
private:
MCString m_mssRegistry; //!< way to save name/value pairs. Note there is no encryption involved in this
};
class CModules : public vector<CModule*> {
public:
CModules();
virtual ~CModules();
void SetUser(CUser* pUser) { m_pUser = pUser; }
void SetClient(CClient* pClient);
void UnloadAll();
virtual bool OnBoot(); // Return false to abort
virtual void OnIRCDisconnected();
virtual void OnIRCConnected();
virtual bool OnBroadcast(CString& sMessage);
virtual bool OnDCCUserSend(const CNick& RemoteNick, unsigned long uLongIP, unsigned short uPort, const CString& sFile, unsigned long uFileSize);
virtual void OnChanPermission(const CNick& OpNick, const CNick& Nick, CChan& Channel, unsigned char uMode, bool bAdded, bool bNoChange);
virtual void OnOp(const CNick& OpNick, const CNick& Nick, CChan& Channel, bool bNoChange);
virtual void OnDeop(const CNick& OpNick, const CNick& Nick, CChan& Channel, bool bNoChange);
virtual void OnVoice(const CNick& OpNick, const CNick& Nick, CChan& Channel, bool bNoChange);
virtual void OnDevoice(const CNick& OpNick, const CNick& Nick, CChan& Channel, bool bNoChange);
virtual void OnRawMode(const CNick& OpNick, CChan& Channel, const CString& sModes, const CString& sArgs);
virtual bool OnRaw(CString& sLine);
virtual bool OnStatusCommand(const CString& sCommand);
virtual void OnModCommand(const CString& sCommand);
virtual void OnModNotice(const CString& sMessage);
virtual void OnModCTCP(const CString& sMessage);
virtual void OnQuit(const CNick& Nick, const CString& sMessage, const vector<CChan*>& vChans);
virtual void OnNick(const CNick& Nick, const CString& sNewNick, const vector<CChan*>& vChans);
virtual void OnKick(const CNick& Nick, const CString& sOpNick, CChan& Channel, const CString& sMessage);
virtual void OnJoin(const CNick& Nick, CChan& Channel);
virtual void OnPart(const CNick& Nick, CChan& Channel);
virtual void OnUserAttached();
virtual void OnUserDetached();
virtual bool OnUserRaw(CString& sLine);
virtual bool OnUserCTCPReply(CString& sTarget, CString& sMessage);
virtual bool OnUserCTCP(CString& sTarget, CString& sMessage);
virtual bool OnUserMsg(CString& sTarget, CString& sMessage);
virtual bool OnUserNotice(CString& sTarget, CString& sMessage);
virtual bool OnUserJoin(CString& sChannel, CString& sKey);
virtual bool OnUserPart(CString& sChannel, CString& sMessage);
virtual bool OnCTCPReply(CNick& Nick, CString& sMessage);
virtual bool OnPrivCTCP(CNick& Nick, CString& sMessage);
virtual bool OnChanCTCP(CNick& Nick, CChan& Channel, CString& sMessage);
virtual bool OnPrivMsg(CNick& Nick, CString& sMessage);
virtual bool OnChanMsg(CNick& Nick, CChan& Channel, CString& sMessage);
virtual bool OnPrivNotice(CNick& Nick, CString& sMessage);
virtual bool OnChanNotice(CNick& Nick, CChan& Channel, CString& sMessage);
CModule* FindModule(const CString& sModule) const;
bool LoadModule(const CString& sModule, const CString& sArgs, CUser* pUser, CString& sRetMsg, bool bFake = false);
bool UnloadModule(const CString& sModule);
bool UnloadModule(const CString& sModule, CString& sRetMsg);
bool ReloadModule(const CString& sModule, const CString& sArgs, CUser* pUser, CString& sRetMsg);
CString FindModPath(const CString& sModule);
bool GetModInfo(CModInfo& ModInfo, const CString& sModule);
void GetAvailableMods(set<CModInfo>& ssMods, bool bGlobal = false);
protected:
CUser* m_pUser;
};
class CGlobalModule : public CModule {
public:
CGlobalModule(void* pDLL, const CString& sModName) : CModule(pDLL, sModName) {}
virtual ~CGlobalModule() {}
virtual EModRet OnConfigLine(const CString& sName, const CString& sValue, CUser* pUser, CChan* pChan);
private:
};
class CGlobalModules : public CModules {
public:
CGlobalModules() : CModules() {}
virtual ~CGlobalModules() {}
virtual bool OnConfigLine(const CString& sName, const CString& sValue, CUser* pUser, CChan* pChan);
private:
};
#endif // !_MODULES_H
|