mirror of
https://github.com/znc/znc.git
synced 2026-05-08 22:34:45 +02:00
Add some doxygen comments
This adds doxygen comments to the most important functions from CModule and CGlobalModule. git-svn-id: https://znc.svn.sourceforge.net/svnroot/znc/trunk@1715 726aef4b-f618-498e-8847-2d620e286838
This commit is contained in:
psychon
@@ -208,6 +208,19 @@ protected:
|
||||
CString m_sDescription;
|
||||
};
|
||||
|
||||
/** The base class for your own ZNC modules.
|
||||
*
|
||||
* If you want to write a module for znc, you will have to implement a class
|
||||
* which inherits from this class. You should override some of the "On*"
|
||||
* functions in this class. These function will then be called by ZNC when the
|
||||
* associated event happens.
|
||||
*
|
||||
* If such a module hook is called with a non-const reference to e.g. a
|
||||
* CString, then it is free to modify that argument to influence ZNC's
|
||||
* behavior.
|
||||
*
|
||||
* @see MODCONSTRUCTOR and MODULEDEFS
|
||||
*/
|
||||
class CModule {
|
||||
public:
|
||||
CModule(ModHandle pDLL, CUser* pUser, const CString& sModName,
|
||||
@@ -215,101 +228,426 @@ public:
|
||||
CModule(ModHandle pDLL, const CString& sModName, const CString& sDataDir);
|
||||
virtual ~CModule();
|
||||
|
||||
/** This enum is just used for return from module hooks. Based on this
|
||||
* return, ZNC then decides what to do with the event which caused the
|
||||
* module hook.
|
||||
*/
|
||||
typedef enum {
|
||||
/** ZNC will continue event processing normally. This is what
|
||||
* you should return normally.
|
||||
*/
|
||||
CONTINUE = 1,
|
||||
/** This is the same as both CModule::HALTMODS and
|
||||
* CModule::HALTCORE together.
|
||||
*/
|
||||
HALT = 2,
|
||||
/** Stop sending this even to other modules which were not
|
||||
* called yet. Internally, the event is handled normally.
|
||||
*/
|
||||
HALTMODS = 3,
|
||||
/** Continue calling other modules. When done, ignore the event
|
||||
* in the ZNC core. (For most module hooks this means that a
|
||||
* given event won't be forwarded to the connected users)
|
||||
*/
|
||||
HALTCORE = 4
|
||||
} EModRet;
|
||||
|
||||
typedef enum {
|
||||
/** Your module can throw this enum at any given time. When this
|
||||
* is thrown, the module will be unloaded.
|
||||
*/
|
||||
UNLOAD
|
||||
} EModException;
|
||||
|
||||
void SetUser(CUser* pUser);
|
||||
void SetClient(CClient* pClient);
|
||||
|
||||
/** This function throws CModule::UNLOAD which causes this module to be unloaded.
|
||||
*/
|
||||
void Unload();
|
||||
|
||||
/** This module hook is called when a module is loaded
|
||||
* @param sArgsi The arguments for the modules.
|
||||
* @param sMessage A message that may be displayed to the user after
|
||||
* loading the module. Useful for returning error messages.
|
||||
* @return true if the module loaded successfully, else false.
|
||||
*/
|
||||
virtual bool OnLoad(const CString& sArgsi, CString& sMessage);
|
||||
/** This module hook is called during ZNC startup. Only modules loaded
|
||||
* from znc.conf get this call.
|
||||
* @return false to abort ZNC startup.
|
||||
*/
|
||||
virtual bool OnBoot();
|
||||
/** Called just before znc.conf is rehashed */
|
||||
virtual void OnPreRehash();
|
||||
/** This module hook is called after a <em>successful</em> rehash. */
|
||||
virtual void OnPostRehash();
|
||||
/** This module hook is called when a user gets disconnected from IRC. */
|
||||
virtual void OnIRCDisconnected();
|
||||
/** This module hook is called after a successful login to IRC. */
|
||||
virtual void OnIRCConnected();
|
||||
/** This module hook is called just before ZNC tries to establish a
|
||||
* connection to an IRC server.
|
||||
* @param pIRCSock The socket that will be used for the connection.
|
||||
* @return See CModule::EModRet.
|
||||
*/
|
||||
virtual EModRet OnIRCConnecting(CIRCSock *pIRCSock);
|
||||
/** This module hook is called before loging in to the IRC server. The
|
||||
* low-level connection is established at this point, but SSL
|
||||
* handshakes didn't necessarily finish yet.
|
||||
* @param sPass The server password that will be used.
|
||||
* @param sNick The nick that will be used.
|
||||
* @param sIdent The protocol identity that will be used. This is not
|
||||
* the ident string that is transfered via e.g. oidentd!
|
||||
* @param sRealName The real name that will be used.
|
||||
* @return See CModule::EModRet.
|
||||
*/
|
||||
virtual EModRet OnIRCRegistration(CString& sPass, CString& sNick, CString& sIdent, CString& sRealName);
|
||||
/** This module hook is called when a message is broadcasted to all users.
|
||||
* @param sMessage The message that is broadcasted.
|
||||
* @return see CModule::EModRet
|
||||
*/
|
||||
virtual EModRet OnBroadcast(CString& sMessage);
|
||||
|
||||
/** This module hook is called when a user sends a DCC SEND request to
|
||||
* your module fake-nickname.
|
||||
*/
|
||||
virtual EModRet OnDCCUserSend(const CNick& RemoteNick, unsigned long uLongIP, unsigned short uPort, const CString& sFile, unsigned long uFileSize);
|
||||
|
||||
/** This module hook is called when a user mode on a channel changes.
|
||||
* @param OpNick The nick who sent the mode change.
|
||||
* @param Nick The nick whose channel mode changes.
|
||||
* @param Channel The channel on which the user mode is changed.
|
||||
* @param uMode The mode character that is changed, e.g. '@' for op.
|
||||
* @param bAdded True if the mode is added, else false.
|
||||
* @param bNoChange true if this mode change doesn't change anything
|
||||
* because the nick already had this permission.
|
||||
* @see CIRCSock::GetModeType() for converting uMode into a mode (e.g.
|
||||
* 'o' for op).
|
||||
*/
|
||||
virtual void OnChanPermission(const CNick& OpNick, const CNick& Nick, CChan& Channel, unsigned char uMode, bool bAdded, bool bNoChange);
|
||||
/** Called when a nick is opped on a channel */
|
||||
virtual void OnOp(const CNick& OpNick, const CNick& Nick, CChan& Channel, bool bNoChange);
|
||||
/** Called when a nick is deopped on a channel */
|
||||
virtual void OnDeop(const CNick& OpNick, const CNick& Nick, CChan& Channel, bool bNoChange);
|
||||
/** Called when a nick is voiced on a channel */
|
||||
virtual void OnVoice(const CNick& OpNick, const CNick& Nick, CChan& Channel, bool bNoChange);
|
||||
/** Called when a nick is devoiced on a channel */
|
||||
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);
|
||||
/** Called on an individual channel mode change.
|
||||
* @param OpNick The nick who changes the channel mode.
|
||||
* @param Channel The channel whose mode is changed.
|
||||
* @param uMode The mode character that is changed.
|
||||
* @param sArg The argument to the mode character, if any.
|
||||
* @param bAdded True if this mode is added ("+"), else false.
|
||||
* @param bNoChange True if this mode was already effective before.
|
||||
*/
|
||||
virtual void OnMode(const CNick& OpNick, CChan& Channel, char uMode, const CString& sArg, bool bAdded, bool bNoChange);
|
||||
/** Called on any channel mode change. This is called before the more
|
||||
* detailed mode hooks like e.g. OnOp() and OnMode().
|
||||
* @param OpNick The nick who changes the channel mode.
|
||||
* @param Channel The channel whose mode is changed.
|
||||
* @param sModes The raw mode change, e.g. "+s-io".
|
||||
* @param sArgs All arguments to the mode change from sModes.
|
||||
*/
|
||||
virtual void OnRawMode(const CNick& OpNick, CChan& Channel, const CString& sModes, const CString& sArgs);
|
||||
|
||||
/** Called on any raw IRC line received from the <em>IRC server</em>.
|
||||
* @param sLine The line read from the server.
|
||||
* @return See CModule::EModRet.
|
||||
*/
|
||||
virtual EModRet OnRaw(CString& sLine);
|
||||
|
||||
/** Called when a command to *status is sent.
|
||||
* @param sCommand The command sent.
|
||||
* @return See CModule::EModRet.
|
||||
*/
|
||||
virtual EModRet OnStatusCommand(CString& sCommand);
|
||||
/** Called when a command to your module is sent, e.g. query to *modname.
|
||||
* @param sCommand The command that was sent.
|
||||
*/
|
||||
virtual void OnModCommand(const CString& sCommand);
|
||||
/** Called when a your module nick was sent a notice.
|
||||
* @param sMessage The message which was sent.
|
||||
*/
|
||||
virtual void OnModNotice(const CString& sMessage);
|
||||
/** Called when your module nick was sent a CTCP message. OnModCommand()
|
||||
* won't be called for this message.
|
||||
* @param sMessage The message which was sent.
|
||||
*/
|
||||
virtual void OnModCTCP(const CString& sMessage);
|
||||
|
||||
/** Called when a nick quit from IRC.
|
||||
* @param Nick The nick which quit.
|
||||
* @param sMessage The quit message.
|
||||
* @param vChans List of channels which you and nick share.
|
||||
*/
|
||||
virtual void OnQuit(const CNick& Nick, const CString& sMessage, const vector<CChan*>& vChans);
|
||||
/** Called when a nickname change occurs. If we are changing our nick,
|
||||
* sNewNick will equal m_pIRCSock->GetNick().
|
||||
* @param Nick The nick which changed its nickname
|
||||
* @param sNewNick The new nickname.
|
||||
* @param vChans Channels which we and nick share.
|
||||
*/
|
||||
virtual void OnNick(const CNick& Nick, const CString& sNewNick, const vector<CChan*>& vChans);
|
||||
/** Called when a nick is kicked from a channel.
|
||||
* @param Nick The nick which is kicked.
|
||||
* @param sOpNick The nick which generated the kick.
|
||||
* @param Channel The channel on which this kick occurs.
|
||||
* @param sMessage The kick message.
|
||||
*/
|
||||
virtual void OnKick(const CNick& Nick, const CString& sOpNick, CChan& Channel, const CString& sMessage);
|
||||
/** Called when a nick joins a channel.
|
||||
* @param Nick The nick who joined.
|
||||
* @param Channel The channel which was joined.
|
||||
*/
|
||||
virtual void OnJoin(const CNick& Nick, CChan& Channel);
|
||||
/** Called when a nick parts a channel.
|
||||
* @param Nick The nick who parted.
|
||||
* @param Channel The channel which was parted.
|
||||
*/
|
||||
virtual void OnPart(const CNick& Nick, CChan& Channel);
|
||||
|
||||
/** Called before a channel buffer is played back to a client.
|
||||
* @param Chan The channel which will be played back.
|
||||
* @param Client The client the buffer will be played back to.
|
||||
* @return See CModule::EModRet.
|
||||
*/
|
||||
virtual EModRet OnChanBufferStarting(CChan& Chan, CClient& Client);
|
||||
/** Called after a channel buffer was played back to a client.
|
||||
* @param Chan The channel which was played back.
|
||||
* @param Client The client the buffer was played back to.
|
||||
* @return See CModule::EModRet.
|
||||
*/
|
||||
virtual EModRet OnChanBufferEnding(CChan& Chan, CClient& Client);
|
||||
/** Called when for each line during a channel's buffer play back.
|
||||
* @param Chan The channel this playback is from.
|
||||
* @param Client The client the buffer is played back to.
|
||||
* @param sLine The current line of buffer playback. This is a raw IRC
|
||||
* traffic line!
|
||||
* @return See CModule::EModRet.
|
||||
*/
|
||||
virtual EModRet OnChanBufferPlayLine(CChan& Chan, CClient& Client, CString& sLine);
|
||||
/** Called when a line from the query buffer is played back.
|
||||
* @param Client The client this line will go to.
|
||||
* @param sLine The raw IRC traffic line from the buffer.
|
||||
* @return See CModule::EModRet.
|
||||
*/
|
||||
virtual EModRet OnPrivBufferPlayLine(CClient& Client, CString& sLine);
|
||||
|
||||
/** @deprecated Use CModule::OnClientLogin instead. */
|
||||
virtual void OnUserAttached(bool thisFunctionWasRemoved, bool UseOnClientLogin) {}
|
||||
/** @deprecated Use CModule::OnClientDisconnect instead. */
|
||||
virtual void OnUserDetached(bool thisFunctionWasRemoved, bool UseOnClientDisconnect) {}
|
||||
/** Called when a client successfully logged in to ZNC. */
|
||||
virtual void OnClientLogin();
|
||||
/** Called when a client disconnected from ZNC. */
|
||||
virtual void OnClientDisconnect();
|
||||
/** This module hook is called when a client sends a raw traffic line to ZNC.
|
||||
* @param sLine The raw traffic line sent.
|
||||
* @return See CModule::EModRet.
|
||||
*/
|
||||
virtual EModRet OnUserRaw(CString& sLine);
|
||||
/** This module hook is called when a client sends a CTCP reply.
|
||||
* @param sTarget The target for the CTCP reply. Could be a channel
|
||||
* name or a nick name.
|
||||
* @param sMessage The CTCP reply message.
|
||||
* @return See CModule::EModRet.
|
||||
*/
|
||||
virtual EModRet OnUserCTCPReply(CString& sTarget, CString& sMessage);
|
||||
/** This module hook is called when a client sends a CTCP request.
|
||||
* @param sTarget The target for the CTCP request. Could be a channel
|
||||
* name or a nick name.
|
||||
* @param sMessage The CTCP request message.
|
||||
* @return See CModule::EModRet.
|
||||
* @note This is not called for CTCP ACTION messages, use
|
||||
* CModule::OnUserAction() instead.
|
||||
*/
|
||||
virtual EModRet OnUserCTCP(CString& sTarget, CString& sMessage);
|
||||
/** Called when a client sends a CTCP ACTION request ("/me").
|
||||
* @param sTarget The target for the CTCP ACTION. Could be a channel
|
||||
* name or a nick name.
|
||||
* @param sMessage The action message.
|
||||
* @return See CModule::EModRet.
|
||||
* @note CModule::OnUserCTCP() will not be called for this message.
|
||||
*/
|
||||
virtual EModRet OnUserAction(CString& sTarget, CString& sMessage);
|
||||
/** This module hook is called when a user sends a normal IRC message.
|
||||
* @param sTarget The target of the message. Could be a channel name or
|
||||
* a nick name.
|
||||
* @param sMessage The message which was sent.
|
||||
* @return See CModule::EModRet.
|
||||
*/
|
||||
virtual EModRet OnUserMsg(CString& sTarget, CString& sMessage);
|
||||
/** This module hook is called when a user sends a notice message.
|
||||
* @param sTarget The target of the message. Could be a channel name or
|
||||
* a nick name.
|
||||
* @param sMessage The message which was sent.
|
||||
* @return See CModule::EModRet.
|
||||
*/
|
||||
virtual EModRet OnUserNotice(CString& sTarget, CString& sMessage);
|
||||
/** This hooks is called when a user sends a JOIN message.
|
||||
* @param sChannel The channel name the join is for.
|
||||
* @param sKey The key for the channel.
|
||||
* @return See CModule::EModRet.
|
||||
*/
|
||||
virtual EModRet OnUserJoin(CString& sChannel, CString& sKey);
|
||||
/** This hooks is called when a user sends a PART message.
|
||||
* @param sChannel The channel name the part is for.
|
||||
* @param sMessage The part message the client sent.
|
||||
* @return See CModule::EModRet.
|
||||
*/
|
||||
virtual EModRet OnUserPart(CString& sChannel, CString& sMessage);
|
||||
/** This module hook is called when a user wants to change a channel topic.
|
||||
* @param sChannel The channel.
|
||||
* @param sTopic The new topic which the user sent.
|
||||
* @return See CModule::EModRet.
|
||||
*/
|
||||
virtual EModRet OnUserTopic(CString& sChannel, CString& sTopic);
|
||||
/** This hook is called when a user requests a channel's topic.
|
||||
* @param sChannel The channel for which the request is.
|
||||
* @return See CModule::EModRet.
|
||||
*/
|
||||
virtual EModRet OnUserTopicRequest(CString& sChannel);
|
||||
|
||||
/** Called when we receive a CTCP reply <em>from IRC</em>.
|
||||
* @param Nick The nick the CTCP reply is from.
|
||||
* @param sMessage The CTCP reply message.
|
||||
* @return See CModule::EModRet.
|
||||
*/
|
||||
virtual EModRet OnCTCPReply(CNick& Nick, CString& sMessage);
|
||||
/** Called when we receive a private CTCP request <em>from IRC</em>.
|
||||
* @param Nick The nick the CTCP request is from.
|
||||
* @param sMessage The CTCP request message.
|
||||
* @return See CModule::EModRet.
|
||||
*/
|
||||
virtual EModRet OnPrivCTCP(CNick& Nick, CString& sMessage);
|
||||
/** Called when we receive a channel CTCP request <em>from IRC</em>.
|
||||
* @param Nick The nick the CTCP request is from.
|
||||
* @param Channel The channel to which the request was sent.
|
||||
* @param sMessage The CTCP request message.
|
||||
* @return See CModule::EModRet.
|
||||
*/
|
||||
virtual EModRet OnChanCTCP(CNick& Nick, CChan& Channel, CString& sMessage);
|
||||
/** Called when we receive a private CTCP ACTION ("/me" in query) <em>from IRC</em>.
|
||||
* @param Nick The nick the action came from.
|
||||
* @param sMessage The action message
|
||||
* @return See CModule::EModRet.
|
||||
*/
|
||||
virtual EModRet OnPrivAction(CNick& Nick, CString& sMessage);
|
||||
/** Called when we receive a channel CTCP ACTION ("/me" in a channel) <em>from IRC</em>.
|
||||
* @param Nick The nick the action came from.
|
||||
* @param Channel The channel the action was sent to.
|
||||
* @param sMessage The action message
|
||||
* @return See CModule::EModRet.
|
||||
*/
|
||||
virtual EModRet OnChanAction(CNick& Nick, CChan& Channel, CString& sMessage);
|
||||
/** Called when we receive a private message <em>from IRC</em>.
|
||||
* @param Nick The nick which sent the message.
|
||||
* @param sMessage The message.
|
||||
* @return See CModule::EModRet.
|
||||
*/
|
||||
virtual EModRet OnPrivMsg(CNick& Nick, CString& sMessage);
|
||||
/** Called when we receive a channel message <em>from IRC</em>.
|
||||
* @param Nick The nick which sent the message.
|
||||
* @param Channel The channel to which the message was sent.
|
||||
* @param sMessage The message.
|
||||
* @return See CModule::EModRet.
|
||||
*/
|
||||
virtual EModRet OnChanMsg(CNick& Nick, CChan& Channel, CString& sMessage);
|
||||
/** Called when we receive a private notice.
|
||||
* @param Nick The nick which sent the notice.
|
||||
* @param sMessage The notice message.
|
||||
* @return See CModule::EModRet.
|
||||
*/
|
||||
virtual EModRet OnPrivNotice(CNick& Nick, CString& sMessage);
|
||||
/** Called when we receive a channel notice.
|
||||
* @param Nick The nick which sent the notice.
|
||||
* @param Channel The channel to which the notice was sent.
|
||||
* @param sMessage The notice message.
|
||||
* @return See CModule::EModRet.
|
||||
*/
|
||||
virtual EModRet OnChanNotice(CNick& Nick, CChan& Channel, CString& sMessage);
|
||||
/** Called when we receive a channel topic change <em>from IRC</em>.
|
||||
* @param Nick The nick which changed the topic.
|
||||
* @param Channel The channel whose topic was changed.
|
||||
* @param sTopic The new topic.
|
||||
* @return See CModule::EModRet.
|
||||
*/
|
||||
virtual EModRet OnTopic(CNick& Nick, CChan& Channel, CString& sTopic);
|
||||
|
||||
/** This module hook is called just before ZNC tries to join a channel
|
||||
* by itself because it's in the config but wasn't joined yet.
|
||||
* @param Channel The channel which will be joined.
|
||||
* @return See CModule::EModRet.
|
||||
*/
|
||||
virtual EModRet OnTimerAutoJoin(CChan& Channel);
|
||||
|
||||
ModHandle GetDLL();
|
||||
static double GetCoreVersion() { return VERSION; }
|
||||
|
||||
/** This function sends a given raw IRC line to the IRC server, if we
|
||||
* are connected to one. Else this line is discarded.
|
||||
* @param sLine The line which should be sent.
|
||||
* @return true if the line was queued for sending.
|
||||
*/
|
||||
virtual bool PutIRC(const CString& sLine);
|
||||
/** This function sends a given raw IRC line to a client.
|
||||
* If we are in a module hook which is called for a specific client,
|
||||
* only that client will get the line, else all connected clients will
|
||||
* receive this line.
|
||||
* @param sLine The line which should be sent.
|
||||
* @return true if the line was sent to at least one client.
|
||||
*/
|
||||
virtual bool PutUser(const CString& sLine);
|
||||
/** This function generates a query from *status. If we are in a module
|
||||
* hook for a specific client, only that client gets this message, else
|
||||
* all connected clients will receive it.
|
||||
* @param sLine The message which should be sent from *status.
|
||||
* @return true if the line was sent to at least one client.
|
||||
*/
|
||||
virtual bool PutStatus(const CString& sLine);
|
||||
/** This function sends a query from your module nick. If we are in a
|
||||
* module hook for a specific client, only that client gets this
|
||||
* message, else all connected clients will receive it.
|
||||
* @param sLine The message which should be sent.
|
||||
* @param sIdent The ident for the module nick. Defaults to the module name.
|
||||
* @param sHost The hostname for the module nick. Defaults to znc.in
|
||||
* @return true if the line was sent to at least one client.
|
||||
*/
|
||||
virtual bool PutModule(const CString& sLine, const CString& sIdent = "", const CString& sHost = "znc.in");
|
||||
/** This function calls CModule::PutModule(const CString&, const
|
||||
* CString&, const CString&) for each line in the table.
|
||||
* @param table The table which should be send.
|
||||
* @param sIdent The ident which should be used.
|
||||
* @param sHost The hostname used for the query.
|
||||
* @return The number of lines sent.
|
||||
*/
|
||||
virtual unsigned int PutModule(const CTable& table, const CString& sIdent = "", const CString& sHost = "znc.in");
|
||||
/** Send a notice from your module nick. If we are in a module hook for
|
||||
* a specific client, only that client gets this notice, else all
|
||||
* clients will receive it.
|
||||
* @param sLine The line which should be sent.
|
||||
* @param sIdent The ident used for the notice.
|
||||
* @param sHost The host name used for the notice.
|
||||
* @return true if the line was sent to at least one client.
|
||||
*/
|
||||
virtual bool PutModNotice(const CString& sLine, const CString& sIdent = "", const CString& sHost = "znc.in");
|
||||
|
||||
/** @returns The name of the module. */
|
||||
const CString& GetModName() const { return m_sModName; }
|
||||
// This is where constant module data (e.g. webadmin skins) are saved
|
||||
const CString& GetModDataDir() const { return m_sDataDir; }
|
||||
|
||||
/** @returns The nick of the module. This is just the module name
|
||||
* prefixed by the status prefix.
|
||||
*/
|
||||
CString GetModNick() const;
|
||||
|
||||
/** Get the module's data dir.
|
||||
* Modules can be accompanied by static data, e.g. skins for webadmin.
|
||||
* These function will return the path to that data.
|
||||
*/
|
||||
const CString& GetModDataDir() const { return m_sDataDir; }
|
||||
|
||||
// Timer stuff
|
||||
bool AddTimer(CTimer* pTimer);
|
||||
bool AddTimer(FPTimer_t pFBCallback, const CString& sLabel, u_int uInterval, u_int uCycles = 0, const CString& sDescription = "");
|
||||
@@ -358,7 +696,16 @@ public:
|
||||
bool IsGlobal() const { return m_bGlobal; }
|
||||
const CString& GetDescription() const { return m_sDescription; }
|
||||
const CString& GetArgs() const { return m_sArgs; }
|
||||
|
||||
/** @returns For user modules this returns the user for which this
|
||||
* module was loaded. For global modules this returns NULL,
|
||||
* except when we are in a user-specific module hook in which
|
||||
* case this is the user pointer.
|
||||
*/
|
||||
CUser* GetUser() { return m_pUser; }
|
||||
/** @returns NULL except when we are in a client-specific module hook in
|
||||
* which case this is the client for which the hook is called.
|
||||
*/
|
||||
CClient* GetClient() { return m_pClient; }
|
||||
CSockManager* GetManager() { return m_pManager; }
|
||||
// !Getters
|
||||
@@ -483,17 +830,65 @@ protected:
|
||||
CClient* m_pClient;
|
||||
};
|
||||
|
||||
/** Base class for global modules. If you want to write a global module, your
|
||||
* module class has to derive from CGlobalModule instead of CModule.
|
||||
*
|
||||
* All the module hooks from CModule work here, too. The difference is that
|
||||
* they are now called for all users instead of just a specific one.
|
||||
*
|
||||
* Instead of MODCONSTRUCTOR and MODULEDEFS, you will have to use
|
||||
* GLOBALMODCONSTRUCTOR and GLOBALMODULEDEFS.
|
||||
*/
|
||||
class CGlobalModule : public CModule {
|
||||
public:
|
||||
CGlobalModule(ModHandle pDLL, const CString& sModName,
|
||||
const CString &sDataDir) : CModule(pDLL, sModName, sDataDir) {}
|
||||
virtual ~CGlobalModule() {}
|
||||
|
||||
/** Called when a module-specific config line is read from znc.conf.
|
||||
* Module specific config lines are always prefixed with "GM:".
|
||||
* @param sName Name of the config entry without the "GM:" prefix.
|
||||
* @param sValue The value of the config entry.
|
||||
* @param pUser If this line was found in a user section, then this is
|
||||
* the corresponding CUser instance.
|
||||
* @param pChan If this line was found in a chan section, then this is
|
||||
* the corresponding CChan instance.
|
||||
* @return See CModule::EModRet.
|
||||
* @todo How are modules supposed to write these into the config?
|
||||
*/
|
||||
virtual EModRet OnConfigLine(const CString& sName, const CString& sValue, CUser* pUser, CChan* pChan);
|
||||
/** This module hook is called when a user is deleted.
|
||||
* @param User The user which will be deleted.
|
||||
* @return See CModule::EModRet.
|
||||
*/
|
||||
virtual EModRet OnDeleteUser(CUser& User);
|
||||
/** This module hook is called when there is an incoming connection on
|
||||
* any of ZNC's listening sockets.
|
||||
* @param pClient The incoming client socket.
|
||||
* @param sHost The IP the client is connecting from.
|
||||
* @param uPort The port the client is connecting from.
|
||||
*/
|
||||
virtual void OnClientConnect(CClient* pClient, const CString& sHost, unsigned short uPort);
|
||||
/** This module hook is called when a client tries to login. If your
|
||||
* module wants to handle the login attempt, it must return
|
||||
* CModule::EModRet::HALT;
|
||||
* @param Auth The necessary authentication info for this login attempt.
|
||||
* @return See CModule::EModRet.
|
||||
*/
|
||||
virtual EModRet OnLoginAttempt(CSmartPtr<CAuthBase> Auth);
|
||||
/** Called after a client login was rejected.
|
||||
* @param sUsername The username that tried to log in.
|
||||
* @param sRemoteIP The IP address from which the client tried to login.
|
||||
*/
|
||||
virtual void OnFailedLogin(const CString& sUsername, const CString& sRemoteIP);
|
||||
/** This function behaves like CModule::OnRaw(), but is also called
|
||||
* before the client successfully logged in to ZNC. You should always
|
||||
* prefer to use CModule::OnRaw() if possible.
|
||||
* @param pClient The client.
|
||||
* @param sLine The raw traffic line which the client sent.
|
||||
* @todo Why doesn't this use m_pUser and m_pClient?
|
||||
* (Well, ok, m_pUser isn't known yet...)
|
||||
*/
|
||||
virtual EModRet OnUnknownUserRaw(CClient* pClient, CString& sLine);
|
||||
private:
|
||||
};
|
||||
|
||||
Reference in New Issue
Block a user