mirror of
https://github.com/znc/znc.git
synced 2026-03-28 17:42:41 +01:00
feec20b013
Add OnUserQuit() callback. On smartphone, user doesn't want to see same lines repeatedly. But, meanwhile, user doesn't want to miss lines when connection was lost. To do it, this uses OnUserQuit() callback. With this callback, clearbufferonmsg can clear buffer if user quited client explicitly. And when connection was lost, buffer is still not cleared.
286 lines
11 KiB
C++
286 lines
11 KiB
C++
/*
|
|
* Copyright (C) 2004-2015 ZNC, see the NOTICE file for details.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
class String {
|
|
public:
|
|
CString s;
|
|
};
|
|
|
|
class CModPython;
|
|
|
|
#if HAVE_VISIBILITY
|
|
#pragma GCC visibility push(default)
|
|
#endif
|
|
class CPyModule : public CModule {
|
|
PyObject* m_pyObj;
|
|
CModPython* m_pModPython;
|
|
VWebSubPages* _GetSubPages();
|
|
public:
|
|
CPyModule(CUser* pUser, CIRCNetwork* pNetwork, const CString& sModName, const CString& sDataPath,
|
|
PyObject* pyObj, CModPython* pModPython)
|
|
: CModule(NULL, pUser, pNetwork, sModName, sDataPath) {
|
|
m_pyObj = pyObj;
|
|
Py_INCREF(pyObj);
|
|
m_pModPython = pModPython;
|
|
}
|
|
PyObject* GetPyObj() { // borrows
|
|
return m_pyObj;
|
|
}
|
|
PyObject* GetNewPyObj() {
|
|
Py_INCREF(m_pyObj);
|
|
return m_pyObj;
|
|
}
|
|
void DeletePyModule() {
|
|
Py_CLEAR(m_pyObj);
|
|
delete this;
|
|
}
|
|
CString GetPyExceptionStr();
|
|
CModPython* GetModPython() {
|
|
return m_pModPython;
|
|
}
|
|
|
|
virtual bool OnBoot() override;
|
|
virtual bool WebRequiresLogin() override;
|
|
virtual bool WebRequiresAdmin() override;
|
|
virtual CString GetWebMenuTitle() override;
|
|
virtual bool OnWebPreRequest(CWebSock& WebSock, const CString& sPageName) override;
|
|
virtual bool OnWebRequest(CWebSock& WebSock, const CString& sPageName, CTemplate& Tmpl) override;
|
|
virtual VWebSubPages& GetSubPages() override;
|
|
virtual void OnPreRehash() override;
|
|
virtual void OnPostRehash() override;
|
|
virtual void OnIRCDisconnected() override;
|
|
virtual void OnIRCConnected() override;
|
|
virtual EModRet OnIRCConnecting(CIRCSock *pIRCSock) override;
|
|
virtual void OnIRCConnectionError(CIRCSock *pIRCSock) override;
|
|
virtual EModRet OnIRCRegistration(CString& sPass, CString& sNick, CString& sIdent, CString& sRealName) override;
|
|
virtual EModRet OnBroadcast(CString& sMessage) override;
|
|
virtual void OnChanPermission2(const CNick* pOpNick, const CNick& Nick, CChan& Channel, unsigned char uMode, bool bAdded, bool bNoChange) override;
|
|
virtual void OnOp2(const CNick* pOpNick, const CNick& Nick, CChan& Channel, bool bNoChange) override;
|
|
virtual void OnDeop2(const CNick* pOpNick, const CNick& Nick, CChan& Channel, bool bNoChange) override;
|
|
virtual void OnVoice2(const CNick* pOpNick, const CNick& Nick, CChan& Channel, bool bNoChange) override;
|
|
virtual void OnDevoice2(const CNick* pOpNick, const CNick& Nick, CChan& Channel, bool bNoChange) override;
|
|
virtual void OnMode2(const CNick* pOpNick, CChan& Channel, char uMode, const CString& sArg, bool bAdded, bool bNoChange) override;
|
|
virtual void OnRawMode2(const CNick* pOpNick, CChan& Channel, const CString& sModes, const CString& sArgs) override;
|
|
virtual EModRet OnRaw(CString& sLine) override;
|
|
virtual EModRet OnStatusCommand(CString& sCommand) override;
|
|
virtual void OnModCommand(const CString& sCommand) override;
|
|
virtual void OnModNotice(const CString& sMessage) override;
|
|
virtual void OnModCTCP(const CString& sMessage) override;
|
|
virtual void OnQuit(const CNick& Nick, const CString& sMessage, const std::vector<CChan*>& vChans) override;
|
|
virtual void OnNick(const CNick& Nick, const CString& sNewNick, const std::vector<CChan*>& vChans) override;
|
|
virtual void OnKick(const CNick& OpNick, const CString& sKickedNick, CChan& Channel, const CString& sMessage) override;
|
|
virtual EModRet OnJoining(CChan& Channel) override;
|
|
virtual void OnJoin(const CNick& Nick, CChan& Channel) override;
|
|
virtual void OnPart(const CNick& Nick, CChan& Channel, const CString& sMessage) override;
|
|
virtual EModRet OnChanBufferStarting(CChan& Chan, CClient& Client) override;
|
|
virtual EModRet OnChanBufferEnding(CChan& Chan, CClient& Client) override;
|
|
virtual EModRet OnChanBufferPlayLine(CChan& Chan, CClient& Client, CString& sLine) override;
|
|
virtual EModRet OnPrivBufferPlayLine(CClient& Client, CString& sLine) override;
|
|
virtual void OnClientLogin() override;
|
|
virtual void OnClientDisconnect() override;
|
|
virtual EModRet OnUserRaw(CString& sLine) override;
|
|
virtual EModRet OnUserCTCPReply(CString& sTarget, CString& sMessage) override;
|
|
virtual EModRet OnUserCTCP(CString& sTarget, CString& sMessage) override;
|
|
virtual EModRet OnUserAction(CString& sTarget, CString& sMessage) override;
|
|
virtual EModRet OnUserMsg(CString& sTarget, CString& sMessage) override;
|
|
virtual EModRet OnUserNotice(CString& sTarget, CString& sMessage) override;
|
|
virtual EModRet OnUserJoin(CString& sChannel, CString& sKey) override;
|
|
virtual EModRet OnUserPart(CString& sChannel, CString& sMessage) override;
|
|
virtual EModRet OnUserTopic(CString& sChannel, CString& sTopic) override;
|
|
virtual EModRet OnUserTopicRequest(CString& sChannel) override;
|
|
virtual void OnUserQuit(CString& sMessage) override;
|
|
virtual EModRet OnCTCPReply(CNick& Nick, CString& sMessage) override;
|
|
virtual EModRet OnPrivCTCP(CNick& Nick, CString& sMessage) override;
|
|
virtual EModRet OnChanCTCP(CNick& Nick, CChan& Channel, CString& sMessage) override;
|
|
virtual EModRet OnPrivAction(CNick& Nick, CString& sMessage) override;
|
|
virtual EModRet OnChanAction(CNick& Nick, CChan& Channel, CString& sMessage) override;
|
|
virtual EModRet OnPrivMsg(CNick& Nick, CString& sMessage) override;
|
|
virtual EModRet OnChanMsg(CNick& Nick, CChan& Channel, CString& sMessage) override;
|
|
virtual EModRet OnPrivNotice(CNick& Nick, CString& sMessage) override;
|
|
virtual EModRet OnChanNotice(CNick& Nick, CChan& Channel, CString& sMessage) override;
|
|
virtual EModRet OnTopic(CNick& Nick, CChan& Channel, CString& sTopic) override;
|
|
virtual bool OnServerCapAvailable(const CString& sCap) override;
|
|
virtual void OnServerCapResult(const CString& sCap, bool bSuccess) override;
|
|
virtual EModRet OnTimerAutoJoin(CChan& Channel) override;
|
|
virtual bool OnEmbeddedWebRequest(CWebSock&, const CString&, CTemplate&) override;
|
|
virtual EModRet OnAddNetwork(CIRCNetwork& Network, CString& sErrorRet) override;
|
|
virtual EModRet OnDeleteNetwork(CIRCNetwork& Network) override;
|
|
virtual EModRet OnSendToClient(CString& sLine, CClient& Client) override;
|
|
virtual EModRet OnSendToIRC(CString& sLine) override;
|
|
|
|
// Global Modules
|
|
virtual EModRet OnAddUser(CUser& User, CString& sErrorRet) override;
|
|
virtual EModRet OnDeleteUser(CUser& User) override;
|
|
virtual void OnClientConnect(CZNCSock* pSock, const CString& sHost, unsigned short uPort) override;
|
|
virtual void OnFailedLogin(const CString& sUsername, const CString& sRemoteIP) override;
|
|
virtual EModRet OnUnknownUserRaw(CClient* pClient, CString& sLine) override;
|
|
virtual bool IsClientCapSupported(CClient* pClient, const CString& sCap, bool bState) override;
|
|
virtual void OnClientCapRequest(CClient* pClient, const CString& sCap, bool bState) override;
|
|
virtual EModRet OnModuleLoading(const CString& sModName, const CString& sArgs,
|
|
CModInfo::EModuleType eType, bool& bSuccess, CString& sRetMsg) override;
|
|
virtual EModRet OnModuleUnloading(CModule* pModule, bool& bSuccess, CString& sRetMsg) override;
|
|
virtual EModRet OnGetModInfo(CModInfo& ModInfo, const CString& sModule,
|
|
bool& bSuccess, CString& sRetMsg) override;
|
|
virtual void OnGetAvailableMods(std::set<CModInfo>& ssMods, CModInfo::EModuleType eType) override;
|
|
virtual void OnClientCapLs(CClient* pClient, SCString& ssCaps) override;
|
|
virtual EModRet OnLoginAttempt(std::shared_ptr<CAuthBase> Auth) override;
|
|
};
|
|
|
|
static inline CPyModule* AsPyModule(CModule* p) {
|
|
return dynamic_cast<CPyModule*>(p);
|
|
}
|
|
|
|
inline CPyModule* CreatePyModule(CUser* pUser, CIRCNetwork* pNetwork, const CString& sModName, const CString& sDataPath, PyObject* pyObj, CModPython* pModPython) {
|
|
return new CPyModule(pUser, pNetwork, sModName, sDataPath, pyObj, pModPython);
|
|
}
|
|
|
|
class CPyTimer : public CTimer {
|
|
PyObject* m_pyObj;
|
|
CModPython* m_pModPython;
|
|
public:
|
|
CPyTimer(CPyModule* pModule, unsigned int uInterval, unsigned int uCycles, const CString& sLabel, const CString& sDescription, PyObject* pyObj)
|
|
: CTimer (pModule, uInterval, uCycles, sLabel, sDescription), m_pyObj(pyObj) {
|
|
Py_INCREF(pyObj);
|
|
pModule->AddTimer(this);
|
|
m_pModPython = pModule->GetModPython();
|
|
}
|
|
virtual void RunJob() override;
|
|
PyObject* GetPyObj() { return m_pyObj; }
|
|
PyObject* GetNewPyObj() {
|
|
Py_INCREF(m_pyObj);
|
|
return m_pyObj;
|
|
}
|
|
~CPyTimer();
|
|
};
|
|
|
|
inline CPyTimer* CreatePyTimer(CPyModule* pModule, unsigned int uInterval, unsigned int uCycles,
|
|
const CString& sLabel, const CString& sDescription, PyObject* pyObj) {
|
|
return new CPyTimer(pModule, uInterval, uCycles, sLabel, sDescription, pyObj);
|
|
}
|
|
|
|
class CPySocket : public CSocket {
|
|
PyObject* m_pyObj;
|
|
CModPython* m_pModPython;
|
|
public:
|
|
CPySocket(CPyModule* pModule, PyObject* pyObj) : CSocket(pModule), m_pyObj(pyObj) {
|
|
Py_INCREF(pyObj);
|
|
m_pModPython = pModule->GetModPython();
|
|
}
|
|
PyObject* GetPyObj() { return m_pyObj; }
|
|
PyObject* GetNewPyObj() {
|
|
Py_INCREF(m_pyObj);
|
|
return m_pyObj;
|
|
}
|
|
~CPySocket();
|
|
virtual void Connected() override;
|
|
virtual void Disconnected() override;
|
|
virtual void Timeout() override;
|
|
virtual void ConnectionRefused() override;
|
|
virtual void ReadData(const char *data, size_t len) override;
|
|
virtual void ReadLine(const CString& sLine) override;
|
|
virtual Csock* GetSockObj(const CString& sHost, unsigned short uPort) override;
|
|
};
|
|
|
|
inline CPySocket* CreatePySocket(CPyModule* pModule, PyObject* pyObj) {
|
|
return new CPySocket(pModule, pyObj);
|
|
}
|
|
|
|
inline bool HaveIPv6_() {
|
|
#ifdef HAVE_IPV6
|
|
return true;
|
|
#endif
|
|
return false;
|
|
}
|
|
|
|
inline bool HaveSSL_() {
|
|
#ifdef HAVE_LIBSSL
|
|
return true;
|
|
#endif
|
|
return false;
|
|
}
|
|
|
|
inline bool HaveCharset_() {
|
|
#ifdef HAVE_ICU
|
|
return true;
|
|
#endif
|
|
return false;
|
|
}
|
|
|
|
inline int GetSOMAXCONN() {
|
|
return SOMAXCONN;
|
|
}
|
|
|
|
inline int GetVersionMajor() {
|
|
return VERSION_MAJOR;
|
|
}
|
|
|
|
inline int GetVersionMinor() {
|
|
return VERSION_MINOR;
|
|
}
|
|
|
|
inline double GetVersion() {
|
|
return VERSION;
|
|
}
|
|
|
|
inline CString GetVersionExtra() {
|
|
return ZNC_VERSION_EXTRA;
|
|
}
|
|
|
|
class MCString_iter {
|
|
public:
|
|
MCString_iter() {}
|
|
MCString::iterator x;
|
|
MCString_iter(MCString::iterator z) : x(z) {}
|
|
void plusplus() {
|
|
++x;
|
|
}
|
|
CString get() {
|
|
return x->first;
|
|
}
|
|
bool is_end(CModule* m) {
|
|
return m->EndNV() == x;
|
|
}
|
|
};
|
|
|
|
class CModulesIter {
|
|
public:
|
|
CModulesIter(CModules *pModules) {
|
|
m_pModules = pModules;
|
|
m_it = pModules->begin();
|
|
}
|
|
|
|
void plusplus() {
|
|
++m_it;
|
|
}
|
|
|
|
const CModule* get() const {
|
|
return *m_it;
|
|
}
|
|
|
|
bool is_end() const {
|
|
return m_pModules->end() == m_it;
|
|
}
|
|
|
|
CModules *m_pModules;
|
|
CModules::const_iterator m_it;
|
|
};
|
|
|
|
#if HAVE_VISIBILITY
|
|
#pragma GCC visibility pop
|
|
#endif
|