-/* +------------------------------------+
- * | Inspire Internet Relay Chat Daemon |
- * +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
*
- * InspIRCd: (C) 2002-2007 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ * Copyright (C) 2006-2007, 2009 Dennis Friis <peavey@inspircd.org>
+ * Copyright (C) 2003-2008 Craig Edwards <craigedwards@brainbox.cc>
+ * Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
+ * Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
+ * Copyright (C) 2006-2007 Oliver Lupton <oliverlupton@gmail.com>
+ * Copyright (C) 2003 randomdan <???@???>
*
- * This program is free but copyrighted software; see
- * the file COPYING for details.
+ * This file is part of InspIRCd. InspIRCd 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, version 2.
*
- * ---------------------------------------------------
+ * This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
*/
-#ifndef __MODULES_H
-#define __MODULES_H
-/** Used with OnAccessCheck() method of modules
- */
-enum AccessControlType {
- ACR_DEFAULT, // Do default action (act as if the module isnt even loaded)
- ACR_DENY, // deny the action
- ACR_ALLOW, // allow the action
- AC_KICK, // a user is being kicked
- AC_DEOP, // a user is being deopped
- AC_OP, // a user is being opped
- AC_VOICE, // a user is being voiced
- AC_DEVOICE, // a user is being devoiced
- AC_HALFOP, // a user is being halfopped
- AC_DEHALFOP, // a user is being dehalfopped
- AC_INVITE, // a user is being invited
- AC_GENERAL_MODE // a channel mode is being changed
-};
+#pragma once
+
+#include "dynamic.h"
+#include "base.h"
+#include "ctables.h"
+#include "inspsocket.h"
+#include <string>
+#include <deque>
+#include <sstream>
+#include "timer.h"
+#include "mode.h"
/** Used to define a set of behavior bits for a module
*/
enum ModuleFlags {
+ VF_NONE = 0, // module is not special at all
VF_STATIC = 1, // module is static, cannot be /unloadmodule'd
VF_VENDOR = 2, // module is a vendor module (came in the original tarball, not 3rd party)
- VF_SERVICEPROVIDER = 4, // module provides a service to other modules (can be a dependency)
- VF_COMMON = 8 // module needs to be common on all servers in a network to link
-};
-
-enum WriteModeFlags {
- WM_AND = 1,
- WM_OR = 2
+ VF_COMMON = 4, // module needs to be common on all servers in a network to link
+ VF_OPTCOMMON = 8, // module should be common on all servers for unsurprising behavior
+ VF_CORE = 16 // module is a core command, can be assumed loaded on all servers
};
+/** Used to represent an event type, for user, channel or server
+ */
enum TargetTypeFlags {
TYPE_USER = 1,
TYPE_CHANNEL,
TYPE_OTHER
};
+/** Used to represent wether a message was PRIVMSG or NOTICE
+ */
enum MessageType {
MSG_PRIVMSG = 0,
MSG_NOTICE = 1
};
-#include "globals.h"
-#include "dynamic.h"
-#include "base.h"
-#include "ctables.h"
-#include "inspsocket.h"
-#include <string>
-#include <deque>
-#include <sstream>
-#include "timer.h"
-#include "mode.h"
-#include "dns.h"
+#define MOD_RES_ALLOW (ModResult(1))
+#define MOD_RES_PASSTHRU (ModResult(0))
+#define MOD_RES_DENY (ModResult(-1))
-/** If you change the module API, change this value.
- * If you have enabled ipv6, the sizes of structs is
- * different, and modules will be incompatible with
- * ipv4 servers, so this value will be ten times as
- * high on ipv6 servers.
+/** Used to represent an allow/deny module result.
+ * Not constructed as an enum because it reverses the value logic of some functions;
+ * the compiler will inline accesses to have the same efficiency as integer operations.
*/
-#define NATIVE_API_VERSION 11017
-#ifdef IPV6
-#define API_VERSION (NATIVE_API_VERSION * 10)
-#else
-#define API_VERSION (NATIVE_API_VERSION * 1)
-#endif
-
-class ServerConfig;
-
-/* Forward-delacare module for ModuleMessage etc
- */
-class Module;
-
-/** Low level definition of a FileReader classes file cache area
- */
-typedef std::deque<std::string> file_cache;
-typedef file_cache string_list;
-
-/** Holds a list of 'published features' for modules.
- */
-typedef std::map<std::string,Module*> featurelist;
+struct ModResult {
+ int res;
+ ModResult() : res(0) {}
+ explicit ModResult(int r) : res(r) {}
+ inline bool operator==(const ModResult& r) const
+ {
+ return res == r.res;
+ }
+ inline bool operator!=(const ModResult& r) const
+ {
+ return res != r.res;
+ }
+ inline bool operator!() const
+ {
+ return !res;
+ }
+ inline bool check(bool def) const
+ {
+ return (res == 1 || (res == 0 && def));
+ }
+ /**
+ * Merges two results, preferring ALLOW to DENY
+ */
+ inline ModResult operator+(const ModResult& r) const
+ {
+ if (res == r.res || r.res == 0)
+ return *this;
+ if (res == 0)
+ return r;
+ // they are different, and neither is passthru
+ return MOD_RES_ALLOW;
+ }
+};
-/** Holds a list of modules which implement an interface
+/** InspIRCd major version.
+ * 1.2 -> 102; 2.1 -> 201; 2.12 -> 212
*/
-typedef std::deque<Module*> modulelist;
-
-/** Holds a list of all modules which implement interfaces, by interface name
+#define INSPIRCD_VERSION_MAJ 202
+/** InspIRCd API version.
+ * If you change any API elements, increment this value. This counter should be
+ * reset whenever the major version is changed. Modules can use these two values
+ * and numerical comparisons in preprocessor macros if they wish to support
+ * multiple versions of InspIRCd in one file.
*/
-typedef std::map<std::string, std::pair<int, modulelist> > interfacelist;
+#define INSPIRCD_VERSION_API 1
/**
* This #define allows us to call a method in all
* loaded modules in a readable simple way, e.g.:
- * 'FOREACH_MOD(I_OnXonnwxr,OnConnect(user));'
+ * 'FOREACH_MOD(OnConnect,(user));'
*/
-#define FOREACH_MOD(y,x) if (ServerInstance->Config->global_implementation[y] > 0) { \
- for (int _i = 0; _i <= ServerInstance->GetModuleCount(); _i++) { \
- if (ServerInstance->Config->implement_lists[_i][y]) \
+#define FOREACH_MOD(y,x) do { \
+ const IntModuleList& _handlers = ServerInstance->Modules->EventHandlers[I_ ## y]; \
+ for (IntModuleList::const_reverse_iterator _i = _handlers.rbegin(), _next; _i != _handlers.rend(); _i = _next) \
+ { \
+ _next = _i+1; \
try \
{ \
- ServerInstance->modules[_i]->x ; \
+ (*_i)->y x ; \
} \
catch (CoreException& modexcept) \
{ \
- ServerInstance->Log(DEFAULT,"Exception cought: %s",modexcept.GetReason()); \
+ ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, "Exception caught: " + modexcept.GetReason()); \
} \
} \
- }
+} while (0);
-#define FOREACH_MOD_I(z,y,x) if (z->Config->global_implementation[y] > 0) { \
- for (int _i = 0; _i <= z->GetModuleCount(); _i++) { \
- if (z->Config->implement_lists[_i][y]) \
+/**
+ * Custom module result handling loop. This is a paired macro, and should only
+ * be used with while_each_hook.
+ *
+ * See src/channels.cpp for an example of use.
+ */
+#define DO_EACH_HOOK(n,v,args) \
+do { \
+ const IntModuleList& _handlers = ServerInstance->Modules->EventHandlers[I_ ## n]; \
+ for (IntModuleList::const_reverse_iterator _i = _handlers.rbegin(), _next; _i != _handlers.rend(); _i = _next) \
+ { \
+ _next = _i+1; \
try \
{ \
- z->modules[_i]->x ; \
+ v = (*_i)->n args;
+
+#define WHILE_EACH_HOOK(n) \
} \
- catch (CoreException& modexcept) \
+ catch (CoreException& except_ ## n) \
{ \
- z->Log(DEFAULT,"Exception cought: %s",modexcept.GetReason()); \
+ ServerInstance->Logs->Log("MODULE", LOG_DEFAULT, "Exception caught: " + (except_ ## n).GetReason()); \
} \
} \
-}
+} while(0)
+
/**
- * This define is similar to the one above but returns a result in MOD_RESULT.
- * The first module to return a nonzero result is the value to be accepted,
- * and any modules after are ignored.
+ * Module result iterator
+ * Runs the given hook until some module returns a useful result.
+ *
+ * Example: ModResult result;
+ * FIRST_MOD_RESULT(OnUserPreNick, result, (user, newnick))
*/
-#define FOREACH_RESULT(y,x) { if (ServerInstance->Config->global_implementation[y] > 0) { \
- MOD_RESULT = 0; \
- for (int _i = 0; _i <= ServerInstance->GetModuleCount(); _i++) { \
- if (ServerInstance->Config->implement_lists[_i][y]) { \
- try \
- { \
- int res = ServerInstance->modules[_i]->x ; \
- if (res != 0) { \
- MOD_RESULT = res; \
- break; \
- } \
- } \
- catch (CoreException& modexcept) \
- { \
- ServerInstance->Log(DEFAULT,"Exception cought: %s",modexcept.GetReason()); \
- } \
- } \
- } \
+#define FIRST_MOD_RESULT(n,v,args) do { \
+ v = MOD_RES_PASSTHRU; \
+ DO_EACH_HOOK(n,v,args) \
+ { \
+ if (v != MOD_RES_PASSTHRU) \
+ break; \
} \
- }
-
-#define FOREACH_RESULT_I(z,y,x) { if (z->Config->global_implementation[y] > 0) { \
- MOD_RESULT = 0; \
- for (int _i = 0; _i <= z->GetModuleCount(); _i++) { \
- if (z->Config->implement_lists[_i][y]) { \
- try \
- { \
- int res = z->modules[_i]->x ; \
- if (res != 0) { \
- MOD_RESULT = res; \
- break; \
- } \
- } \
- catch (CoreException& modexcept) \
- { \
- z->Log(DEBUG,"Exception cought: %s",modexcept.GetReason()); \
- } \
- } \
- } \
- } \
-}
-
-#define FD_MAGIC_NUMBER -42
+ WHILE_EACH_HOOK(n); \
+} while (0)
-// useful macros
-
-#define IS_LOCAL(x) ((x->GetFd() > -1) && (x->GetFd() <= MAX_DESCRIPTORS))
-#define IS_REMOTE(x) (x->GetFd() < 0)
-#define IS_MODULE_CREATED(x) (x->GetFd() == FD_MAGIC_NUMBER)
-
-/** Holds a module's Version information
- * The four members (set by the constructor only) indicate details as to the version number
- * of a module. A class of type Version is returned by the GetVersion method of the Module class.
- */
-class Version : public classbase
-{
- public:
- const int Major, Minor, Revision, Build, Flags, API;
- Version(int major, int minor, int revision, int build, int flags, int api_ver);
-};
-
-/** The ModuleMessage class is the base class of Request and Event
- * This class is used to represent a basic data structure which is passed
- * between modules for safe inter-module communications.
+/** Holds a module's Version information.
+ * The members (set by the constructor only) indicate details as to the version number
+ * of a module. A class of type Version is returned by the GetVersion method of the Module class.
*/
-class ModuleMessage : public Extensible
+class CoreExport Version
{
public:
- virtual ~ModuleMessage() {};
-};
-
-/** The Request class is a unicast message directed at a given module.
- * When this class is properly instantiated it may be sent to a module
- * using the Send() method, which will call the given module's OnRequest
- * method with this class as its parameter.
- */
-class Request : public ModuleMessage
-{
- protected:
- /** This member holds a pointer to arbitary data set by the emitter of the message
- */
- char* data;
- /** This should be a null-terminated string identifying the type of request,
- * all modules should define this and use it to determine the nature of the
- * request before they attempt to cast the Request in any way.
- */
- const char* id;
- /** This is a pointer to the sender of the message, which can be used to
- * directly trigger events, or to create a reply.
+ /** Module description
*/
- Module* source;
- /** The single destination of the Request
+ const std::string description;
+
+ /** Flags
*/
- Module* dest;
- public:
- /** Create a new Request
- * This is for the 'old' way of casting whatever the data is
- * to char* and hoping you get the right thing at the other end.
- * This is slowly being depreciated in favor of the 'new' way.
- */
- Request(char* anydata, Module* src, Module* dst);
- /** Create a new Request
- * This is for the 'new' way of defining a subclass
- * of Request and defining it in a common header,
- * passing an object of your Request subclass through
- * as a Request* and using the ID string to determine
- * what to cast it back to and the other end. This is
- * much safer as there are no casts not confirmed by
- * the ID string, and all casts are child->parent and
- * can be checked at runtime with dynamic_cast<>()
- */
- Request(Module* src, Module* dst, const char* idstr);
- /** Fetch the Request data
- */
- char* GetData();
- /** Fetch the ID string
- */
- const char* GetId();
- /** Fetch the request source
- */
- Module* GetSource();
- /** Fetch the request destination (should be 'this' in the receiving module)
- */
- Module* GetDest();
- /** Send the Request.
- * Upon returning the result will be arbitary data returned by the module you
- * sent the request to. It is up to your module to know what this data is and
- * how to deal with it.
- */
- char* Send();
-};
+ const int Flags;
+
+ /** Server linking description string */
+ const std::string link_data;
+
+ /** Simple module version */
+ Version(const std::string &desc, int flags = VF_NONE);
+
+ /** Complex version information, including linking compatability data */
+ Version(const std::string &desc, int flags, const std::string& linkdata);
+ virtual ~Version() {}
+};
/** The Event class is a unicast message directed at all modules.
* When the class is properly instantiated it may be sent to all modules
* using the Send() method, which will trigger the OnEvent method in
* all modules passing the object as its parameter.
*/
-class Event : public ModuleMessage
+class CoreExport Event : public classbase
{
- protected:
- /** This member holds a pointer to arbitary data set by the emitter of the message
- */
- char* data;
+ public:
/** This is a pointer to the sender of the message, which can be used to
* directly trigger events, or to create a reply.
*/
- Module* source;
+ ModuleRef source;
/** The event identifier.
* This is arbitary text which should be used to distinguish
* one type of event from another.
*/
- std::string id;
- public:
+ const std::string id;
+
/** Create a new Event
*/
- Event(char* anydata, Module* src, const std::string &eventid);
- /** Get the Event data
- */
- char* GetData();
- /** Get the event Source
- */
- Module* GetSource();
- /** Get the event ID.
- * Use this to determine the event type for safe casting of the data
- */
- std::string GetEventID();
+ Event(Module* src, const std::string &eventid);
/** Send the Event.
* The return result of an Event::Send() will always be NULL as
* no replies are expected.
*/
- char* Send(InspIRCd* ServerInstance);
+ void Send();
};
-/** This class can be used on its own to represent an exception, or derived to represent a module-specific exception.
- * When a module whishes to abort, e.g. within a constructor, it should throw an exception using ModuleException or
- * a class derived from ModuleException. If a module throws an exception during its constructor, the module will not
- * be loaded. If this happens, the error message returned by ModuleException::GetReason will be displayed to the user
- * attempting to load the module, or dumped to the console if the ircd is currently loading for the first time.
- */
-class CoreException : public std::exception
+class CoreExport DataProvider : public ServiceProvider
{
- protected:
- /** Holds the error message to be displayed
- */
- const std::string err;
- const std::string source;
public:
- /** Default constructor, just uses the error mesage 'Core threw an exception'.
- */
- CoreException() : err("Core threw an exception"), source("The core") {}
- /** This constructor can be used to specify an error message before throwing.
- */
- CoreException(const std::string &message) : err(message), source("The core") {}
- /** This constructor can be used to specify an error message before throwing,
- * and to specify the source of the exception.
- */
- CoreException(const std::string &message, const std::string &src) : err(message), source(src) {}
- /** This destructor solves world hunger, cancels the world debt, and causes the world to end.
- * Actually no, it does nothing. Never mind.
- * @throws Nothing!
- */
- virtual ~CoreException() throw() {};
- /** Returns the reason for the exception.
- * The module should probably put something informative here as the user will see this upon failure.
- */
- virtual const char* GetReason()
- {
- return err.c_str();
- }
-
- virtual const char* GetSource()
- {
- return source.c_str();
- }
+ DataProvider(Module* Creator, const std::string& Name)
+ : ServiceProvider(Creator, Name, SERVICE_DATA) {}
};
-class ModuleException : public CoreException
-{
- public:
- /** Default constructor, just uses the error mesage 'Module threw an exception'.
- */
- ModuleException() : CoreException("Module threw an exception", "A Module") {}
-
- /** This constructor can be used to specify an error message before throwing.
- */
- ModuleException(const std::string &message) : CoreException(message, "A Module") {}
- /** This destructor solves world hunger, cancels the world debt, and causes the world to end.
- * Actually no, it does nothing. Never mind.
- * @throws Nothing!
- */
- virtual ~ModuleException() throw() {};
-};
-
-/** Priority types which can be returned from Module::Prioritize()
+/** Priority types which can be used by Module::Prioritize()
*/
-enum Priority { PRIORITY_FIRST, PRIORITY_DONTCARE, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
+enum Priority { PRIORITY_FIRST, PRIORITY_LAST, PRIORITY_BEFORE, PRIORITY_AFTER };
/** Implementation-specific flags which may be set in Module::Implements()
*/
-enum Implementation { I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart, I_OnRehash, I_OnServerRaw,
- I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois, I_OnUserPreInvite,
- I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNotice, I_OnUserPreNick, I_OnUserMessage, I_OnUserNotice, I_OnMode,
- I_OnGetServerDescription, I_OnSyncUser, I_OnSyncChannel, I_OnSyncChannelMetaData, I_OnSyncUserMetaData,
- I_OnDecodeMetaData, I_ProtoSendMode, I_ProtoSendMetaData, I_OnWallops, I_OnChangeHost, I_OnChangeName, I_OnAddGLine,
- I_OnAddZLine, I_OnAddQLine, I_OnAddKLine, I_OnAddELine, I_OnDelGLine, I_OnDelZLine, I_OnDelKLine, I_OnDelELine, I_OnDelQLine,
- I_OnCleanup, I_OnUserPostNick, I_OnAccessCheck, I_On005Numeric, I_OnKill, I_OnRemoteKill, I_OnLoadModule, I_OnUnloadModule,
- I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnUserRrgister, I_OnCheckInvite,
- I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnStats, I_OnChangeLocalUserHost, I_OnChangeLocalUserGecos, I_OnLocalTopicChange,
- I_OnPostLocalTopicChange, I_OnEvent, I_OnRequest, I_OnOperCompre, I_OnGlobalOper, I_OnPostConnect, I_OnAddBan, I_OnDelBan,
- I_OnRawSocketAccept, I_OnRawSocketClose, I_OnRawSocketWrite, I_OnRawSocketRead, I_OnChangeLocalUserGECOS, I_OnUserRegister,
- I_OnOperCompare, I_OnChannelDelete, I_OnPostOper, I_OnSyncOtherMetaData, I_OnSetAway, I_OnCancelAway, I_OnUserList,
- I_OnPostCommand, I_OnPostJoin, I_OnWhoisLine, I_OnBuildExemptList, I_OnRawSocketConnect, I_OnGarbageCollect, I_OnBufferFlushed };
+enum Implementation
+{
+ I_BEGIN,
+ I_OnUserConnect, I_OnUserQuit, I_OnUserDisconnect, I_OnUserJoin, I_OnUserPart,
+ I_OnSendSnotice, I_OnUserPreJoin, I_OnUserPreKick, I_OnUserKick, I_OnOper, I_OnInfo, I_OnWhois,
+ I_OnUserPreInvite, I_OnUserInvite, I_OnUserPreMessage, I_OnUserPreNick,
+ I_OnUserMessage, I_OnMode, I_OnSyncUser,
+ I_OnSyncChannel, I_OnDecodeMetaData, I_OnAcceptConnection, I_OnUserInit,
+ I_OnChangeHost, I_OnChangeName, I_OnAddLine, I_OnDelLine, I_OnExpireLine,
+ I_OnUserPostNick, I_OnPreMode, I_On005Numeric, I_OnKill, I_OnLoadModule,
+ I_OnUnloadModule, I_OnBackgroundTimer, I_OnPreCommand, I_OnCheckReady, I_OnCheckInvite,
+ I_OnRawMode, I_OnCheckKey, I_OnCheckLimit, I_OnCheckBan, I_OnCheckChannelBan, I_OnExtBanCheck,
+ I_OnStats, I_OnChangeLocalUserHost, I_OnPreTopicChange,
+ I_OnPostTopicChange, I_OnEvent, I_OnGlobalOper, I_OnPostConnect,
+ I_OnChangeLocalUserGECOS, I_OnUserRegister, I_OnChannelPreDelete, I_OnChannelDelete,
+ I_OnPostOper, I_OnSyncNetwork, I_OnSetAway, I_OnPostCommand, I_OnPostJoin,
+ I_OnWhoisLine, I_OnBuildNeighborList, I_OnGarbageCollect, I_OnSetConnectClass,
+ I_OnText, I_OnPassCompare, I_OnNamesListItem, I_OnNumeric,
+ I_OnPreRehash, I_OnModuleRehash, I_OnSendWhoLine, I_OnChangeIdent, I_OnSetUserIP,
+ I_END
+};
/** Base class for all InspIRCd modules
* This class is the base class for InspIRCd modules. All modules must inherit from this class,
* its methods will be called when irc server events occur. class inherited from module must be
* instantiated by the ModuleFactory class (see relevent section) for the module to be initialised.
*/
-class Module : public Extensible
+class CoreExport Module : public classbase, public usecountbase
{
- protected:
- InspIRCd* ServerInstance;
+ /** Detach an event from this module
+ * @param i Event type to detach
+ */
+ void DetachEvent(Implementation i);
+
public:
+ /** File that this module was loaded from
+ */
+ std::string ModuleSourceFile;
+ /** Reference to the dlopen() value
+ */
+ DLLManager* ModuleDLLManager;
+
+ /** If true, this module will be unloaded soon, further unload attempts will fail
+ * Value is used by the ModuleManager internally, you should not modify it
+ */
+ bool dying;
+
+ /** Default constructor.
+ * Creates a module class. Don't do any type of hook registration or checks
+ * for other modules here; do that in init().
+ */
+ Module();
- /** Default constructor
- * Creates a module class.
- * @param Me An instance of the InspIRCd class which will be saved into ServerInstance for your use
+ /** Module setup
* \exception ModuleException Throwing this class, or any class derived from ModuleException, causes loading of the module to abort.
*/
- Module(InspIRCd* Me);
+ virtual void init() {}
- /** Default destructor
+ /** Clean up prior to destruction
+ * If you override, you must call this AFTER your module's cleanup
+ */
+ virtual CullResult cull();
+
+ /** Default destructor.
* destroys a module class
*/
virtual ~Module();
- /** Returns the version number of a Module.
- * The method should return a Version object with its version information assigned via
- * Version::Version
- */
- virtual Version GetVersion();
+ virtual void Prioritize()
+ {
+ }
- /** The Implements function specifies which methods a module should receive events for.
- * The char* parameter passed to this function contains a set of true or false values
- * (1 or 0) which indicate wether each function is implemented. You must use the Iimplementation
- * enum (documented elsewhere on this page) to mark functions as active. For example, to
- * receive events for OnUserJoin():
- *
- * Implements[I_OnUserJoin] = 1;
- *
- * @param The implement list
+ /** This method is called when you should reload module specific configuration:
+ * on boot, on a /REHASH and on module load.
+ * @param status The current status, can be inspected for more information;
+ * also used for reporting configuration errors and warnings.
*/
- virtual void Implements(char* Implements);
+ virtual void ReadConfig(ConfigStatus& status);
- /** Used to set the 'priority' of a module (e.g. when it is called in relation to other modules.
- * Some modules prefer to be called before other modules, due to their design. For example, a
- * module which is expected to operate on complete information would expect to be placed last, so
- * that any other modules which wish to adjust that information would execute before it, to be sure
- * its information is correct. You can change your module's priority by returning one of:
- *
- * PRIORITY_FIRST - To place your module first in the list
- *
- * PRIORITY_LAST - To place your module last in the list
- *
- * PRIORITY_DONTCARE - To leave your module as it is (this is the default value, if you do not implement this function)
- *
- * The result of InspIRCd::PriorityBefore() - To move your module before another named module
- *
- * The result of InspIRCd::PriorityLast() - To move your module after another named module
- *
- * For a good working example of this method call, please see src/modules/m_spanningtree.cpp
- * and src/modules/m_hostchange.so which make use of it. It is highly recommended that unless
- * your module has a real need to reorder its priority, it should not implement this function,
- * as many modules changing their priorities can make the system redundant.
+ /** Returns the version number of a Module.
+ * The method should return a Version object with its version information assigned via
+ * Version::Version
*/
- virtual Priority Prioritize();
+ virtual Version GetVersion() = 0;
/** Called when a user connects.
- * The details of the connecting user are available to you in the parameter userrec *user
+ * The details of the connecting user are available to you in the parameter User *user
* @param user The user who is connecting
*/
- virtual void OnUserConnect(userrec* user);
+ virtual void OnUserConnect(LocalUser* user);
/** Called when a user quits.
- * The details of the exiting user are available to you in the parameter userrec *user
+ * The details of the exiting user are available to you in the parameter User *user
* This event is only called when the user is fully registered when they quit. To catch
* raw disconnections, use the OnUserDisconnect method.
* @param user The user who is quitting
- * @param message The user's quit message
+ * @param message The user's quit message (as seen by non-opers)
+ * @param oper_message The user's quit message (as seen by opers)
*/
- virtual void OnUserQuit(userrec* user, const std::string &message);
+ virtual void OnUserQuit(User* user, const std::string &message, const std::string &oper_message);
/** Called whenever a user's socket is closed.
- * The details of the exiting user are available to you in the parameter userrec *user
+ * The details of the exiting user are available to you in the parameter User *user
* This event is called for all users, registered or not, as a cleanup method for modules
* which might assign resources to user, such as dns lookups, objects and sockets.
* @param user The user who is disconnecting
*/
- virtual void OnUserDisconnect(userrec* user);
+ virtual void OnUserDisconnect(LocalUser* user);
+
+ /** Called whenever a channel is about to be deleted
+ * @param chan The channel being deleted
+ * @return An integer specifying whether or not the channel may be deleted. 0 for yes, 1 for no.
+ */
+ virtual ModResult OnChannelPreDelete(Channel *chan);
/** Called whenever a channel is deleted, either by QUIT, KICK or PART.
* @param chan The channel being deleted
*/
- virtual void OnChannelDelete(chanrec* chan);
+ virtual void OnChannelDelete(Channel* chan);
/** Called when a user joins a channel.
- * The details of the joining user are available to you in the parameter userrec *user,
- * and the details of the channel they have joined is available in the variable chanrec *channel
- * @param user The user who is joining
- * @param channel The channel being joined
+ * The details of the joining user are available to you in the parameter User *user,
+ * and the details of the channel they have joined is available in the variable Channel *channel
+ * @param memb The channel membership being created
+ * @param sync This is set to true if the JOIN is the result of a network sync and the remote user is being introduced
+ * to a channel due to the network sync.
+ * @param created This is true if the join created the channel
+ * @param except_list A list of users not to send to.
*/
- virtual void OnUserJoin(userrec* user, chanrec* channel);
+ virtual void OnUserJoin(Membership* memb, bool sync, bool created, CUList& except_list);
/** Called after a user joins a channel
* Identical to OnUserJoin, but called immediately afterwards, when any linking module has
* seen the join.
- * @param user The user who is joining
- * @param channel The channel being joined
+ * @param memb The channel membership created
*/
- virtual void OnPostJoin(userrec* user, chanrec* channel);
+ virtual void OnPostJoin(Membership* memb);
/** Called when a user parts a channel.
- * The details of the leaving user are available to you in the parameter userrec *user,
- * and the details of the channel they have left is available in the variable chanrec *channel
- * @param user The user who is parting
- * @param channel The channel being parted
- * @param partmessage The part message, or an empty string
+ * The details of the leaving user are available to you in the parameter User *user,
+ * and the details of the channel they have left is available in the variable Channel *channel
+ * @param memb The channel membership being destroyed
+ * @param partmessage The part message, or an empty string (may be modified)
+ * @param except_list A list of users to not send to.
*/
- virtual void OnUserPart(userrec* user, chanrec* channel, const std::string &partmessage);
+ virtual void OnUserPart(Membership* memb, std::string &partmessage, CUList& except_list);
/** Called on rehash.
* This method is called prior to a /REHASH or when a SIGHUP is received from the operating
- * system. You should use it to reload any files so that your module keeps in step with the
- * rest of the application. If a parameter is given, the core has done nothing. The module
- * receiving the event can decide if this parameter has any relevence to it.
- * @param user The user performing the rehash, if any -- if this is server initiated, the
- * value of this variable will be NULL.
- * @param parameter The (optional) parameter given to REHASH from the user.
- */
- virtual void OnRehash(userrec* user, const std::string ¶meter);
-
- /** Called when a raw command is transmitted or received.
- * This method is the lowest level of handler available to a module. It will be called with raw
- * data which is passing through a connected socket. If you wish, you may munge this data by changing
- * the string parameter "raw". If you do this, after your function exits it will immediately be
- * cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where
- * inbound is set to true) the value of user will be the userrec of the connection sending the
- * data. This is not possible for outbound data because the data may be being routed to multiple targets.
- * @param raw The raw string in RFC1459 format
- * @param inbound A flag to indicate wether the data is coming into the daemon or going out to the user
- * @param user The user record sending the text, when inbound == true.
- */
- virtual void OnServerRaw(std::string &raw, bool inbound, userrec* user);
+ * system. This is called in all cases -- including when this server will not execute the
+ * rehash because it is directed at a remote server.
+ *
+ * @param user The user performing the rehash, if any. If this is server initiated, the value of
+ * this variable will be NULL.
+ * @param parameter The (optional) parameter given to REHASH from the user. Empty when server
+ * initiated.
+ */
+ virtual void OnPreRehash(User* user, const std::string ¶meter);
+
+ /** Called on rehash.
+ * This method is called when a user initiates a module-specific rehash. This can be used to do
+ * expensive operations (such as reloading SSL certificates) that are not executed on a normal
+ * rehash for efficiency. A rehash of this type does not reload the core configuration.
+ *
+ * @param user The user performing the rehash.
+ * @param parameter The parameter given to REHASH
+ */
+ virtual void OnModuleRehash(User* user, const std::string ¶meter);
+
+ /** Called whenever a snotice is about to be sent to a snomask.
+ * snomask and type may both be modified; the message may not.
+ * @param snomask The snomask the message is going to (e.g. 'A')
+ * @param type The textual description the snomask will go to (e.g. 'OPER')
+ * @param message The text message to be sent via snotice
+ * @return 1 to block the snotice from being sent entirely, 0 else.
+ */
+ virtual ModResult OnSendSnotice(char &snomask, std::string &type, const std::string &message);
/** Called whenever a user is about to join a channel, before any processing is done.
* Returning a value of 1 from this function stops the process immediately, causing no
* IMPORTANT NOTE!
*
* If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
- * record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of
+ * record is created. This will cause Channel* chan to be NULL. There is very little you can do in form of
* processing on the actual channel record at this point, however the channel NAME will still be passed in
* char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
* @param user The user joining the channel
* @param chan If the channel is a new channel, this will be NULL, otherwise it will be a pointer to the channel being joined
* @param cname The channel name being joined. For new channels this is valid where chan is not.
- * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "@".
+ * @param privs A string containing the users privilages when joining the channel. For new channels this will contain "o".
* You may alter this string to alter the user's modes on the channel.
+ * @param keygiven The key given to join the channel, or an empty string if none was provided
* @return 1 To prevent the join, 0 to allow it.
*/
- virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname, std::string &privs);
-
+ virtual ModResult OnUserPreJoin(LocalUser* user, Channel* chan, const std::string& cname, std::string& privs, const std::string& keygiven);
+
/** Called whenever a user is about to be kicked.
* Returning a value of 1 from this function stops the process immediately, causing no
* output to be sent to the user by the core. If you do this you must produce your own numerics,
* notices etc.
* @param source The user issuing the kick
- * @param user The user being kicked
- * @param chan The channel the user is being kicked from
+ * @param memb The channel membership of the user who is being kicked.
* @param reason The kick reason
* @return 1 to prevent the kick, 0 to continue normally, -1 to explicitly allow the kick regardless of normal operation
*/
- virtual int OnUserPreKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason);
+ virtual ModResult OnUserPreKick(User* source, Membership* memb, const std::string &reason);
/** Called whenever a user is kicked.
* If this method is called, the kick is already underway and cannot be prevented, so
* to prevent a kick, please use Module::OnUserPreKick instead of this method.
* @param source The user issuing the kick
- * @param user The user being kicked
- * @param chan The channel the user is being kicked from
+ * @param memb The channel membership of the user who was kicked.
* @param reason The kick reason
+ * @param except_list A list of users to not send to.
*/
- virtual void OnUserKick(userrec* source, userrec* user, chanrec* chan, const std::string &reason);
+ virtual void OnUserKick(User* source, Membership* memb, const std::string &reason, CUList& except_list);
/** Called whenever a user opers locally.
- * The userrec will contain the oper mode 'o' as this function is called after any modifications
+ * The User will contain the oper mode 'o' as this function is called after any modifications
* are made to the user's structure by the core.
* @param user The user who is opering up
* @param opertype The opers type name
*/
- virtual void OnOper(userrec* user, const std::string &opertype);
+ virtual void OnOper(User* user, const std::string &opertype);
/** Called after a user opers locally.
* This is identical to Module::OnOper(), except it is called after OnOper so that other modules
* can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent
* out the OPERTYPE, etc.
* @param user The user who is opering up
+ * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise.
* @param opertype The opers type name
*/
- virtual void OnPostOper(userrec* user, const std::string &opertype);
-
+ virtual void OnPostOper(User* user, const std::string &opername, const std::string &opertype);
+
/** Called whenever a user types /INFO.
- * The userrec will contain the information of the user who typed the command. Modules may use this
+ * The User will contain the information of the user who typed the command. Modules may use this
* method to output their own credits in /INFO (which is the ircd's version of an about box).
* It is purposefully not possible to modify any info that has already been output, or halt the list.
* You must write a 371 numeric to the user, containing your info in the following format:
*
* @param user The user issuing /INFO
*/
- virtual void OnInfo(userrec* user);
-
+ virtual void OnInfo(User* user);
+
/** Called whenever a /WHOIS is performed on a local user.
* The source parameter contains the details of the user who issued the WHOIS command, and
* the dest parameter contains the information of the user they are whoising.
* @param source The user issuing the WHOIS command
* @param dest The user who is being WHOISed
*/
- virtual void OnWhois(userrec* source, userrec* dest);
-
+ virtual void OnWhois(User* source, User* dest);
+
/** Called whenever a user is about to invite another user into a channel, before any processing is done.
* Returning 1 from this function stops the process immediately, causing no
* output to be sent to the user by the core. If you do this you must produce your own numerics,
* @param source The user who is issuing the INVITE
* @param dest The user being invited
* @param channel The channel the user is being invited to
- * @return 1 to deny the invite, 0 to allow
+ * @param timeout The time the invite will expire (0 == never)
+ * @return 1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite
*/
- virtual int OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel);
-
+ virtual ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout);
+
/** Called after a user has been successfully invited to a channel.
* You cannot prevent the invite from occuring using this function, to do that,
* use OnUserPreInvite instead.
* @param source The user who is issuing the INVITE
* @param dest The user being invited
* @param channel The channel the user is being invited to
+ * @param timeout The time the invite will expire (0 == never)
*/
- virtual void OnUserInvite(userrec* source,userrec* dest,chanrec* channel);
-
+ virtual void OnUserInvite(User* source,User* dest,Channel* channel, time_t timeout);
+
/** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
* Returning any nonzero value from this function stops the process immediately, causing no
* output to be sent to the user by the core. If you do this you must produce your own numerics,
* notices etc. This is useful for modules which may want to filter or redirect messages.
* target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
- * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
+ * you must cast dest to a User* otherwise you must cast it to a Channel*, this is the details
* of where the message is destined to be sent.
* @param user The user sending the message
- * @param dest The target of the message (chanrec* or userrec*)
+ * @param dest The target of the message (Channel* or User*)
* @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
* @param text Changeable text being sent by the user
* @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
* @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
* It will be ignored for private messages.
- * @return 1 to deny the NOTICE, 0 to allow it
+ * @param msgtype The message type, MSG_PRIVMSG for PRIVMSGs, MSG_NOTICE for NOTICEs
+ * @return 1 to deny the message, 0 to allow it
*/
- virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
+ virtual ModResult OnUserPreMessage(User* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list, MessageType msgtype);
- /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
- * Returning any nonzero value from this function stops the process immediately, causing no
- * output to be sent to the user by the core. If you do this you must produce your own numerics,
- * notices etc. This is useful for modules which may want to filter or redirect messages.
- * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
- * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
- * of where the message is destined to be sent.
- * You may alter the message text as you wish before relinquishing control to the next module
- * in the chain, and if no other modules block the text this altered form of the text will be sent out
- * to the user and possibly to other servers.
- * @param user The user sending the message
- * @param dest The target of the message (chanrec* or userrec*)
- * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
- * @param text Changeable text being sent by the user
- * @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
- * @param exempt_list A list of users not to send to. For channel notices, this will usually contain just the sender.
- * It will be ignored for private notices.
- * @return 1 to deny the NOTICE, 0 to allow it
- */
- virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text,char status, CUList &exempt_list);
-
- /** Called whenever the server wants to build the exemption list for a channel, but is not directly doing a PRIVMSG or NOTICE.
- * For example, the spanningtree protocol will call this event when passing a privmsg on (but not processing it directly).
- * @param message_type The message type, either MSG_PRIVMSG or MSG_NOTICE
- * @param chan The channel to build the exempt list of
- * @param sender The original sender of the PRIVMSG or NOTICE
- * @param status The status char to be used for the channel list
- * @param exempt_list The exempt list to be populated
- */
- virtual void OnBuildExemptList(MessageType message_type, chanrec* chan, userrec* sender, char status, CUList &exempt_list);
-
- /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
- * Please note that although you can see remote nickchanges through this function, you should
- * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
- * check user->server before taking any action (including returning nonzero from the method).
+ /** Called when sending a message to all "neighbors" of a given user -
+ * that is, all users that share a common channel. This is used in
+ * commands such as NICK, QUIT, etc.
+ * @param source The source of the message
+ * @param include_c Channels to scan for users to include
+ * @param exceptions Map of user->bool that overrides the inclusion decision
+ *
+ * Set exceptions[user] = true to include, exceptions[user] = false to exclude
+ */
+ virtual void OnBuildNeighborList(User* source, IncludeChanList& include_c, std::map<User*, bool>& exceptions);
+
+ /** Called before local nickname changes. This can be used to implement Q-lines etc.
* If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
* module to generate some meaninful output.
* @param user The username changing their nick
* @param newnick Their new nickname
* @return 1 to deny the change, 0 to allow
*/
- virtual int OnUserPreNick(userrec* user, const std::string &newnick);
+ virtual ModResult OnUserPreNick(LocalUser* user, const std::string& newnick);
/** Called after any PRIVMSG sent from a user.
- * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
+ * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
* if target_type is TYPE_CHANNEL.
* @param user The user sending the message
* @param dest The target of the message
* @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
* @param text the text being sent by the user
* @param status The status being used, e.g. PRIVMSG @#chan has status== '@', 0 to send to everyone.
+ * @param exempt_list A list of users to not send to.
+ * @param msgtype The message type, MSG_PRIVMSG for PRIVMSGs, MSG_NOTICE for NOTICEs
*/
- virtual void OnUserMessage(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
+ virtual void OnUserMessage(User* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list, MessageType msgtype);
- /** Called after any NOTICE sent from a user.
- * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
+ /** Called immediately before any NOTICE or PRIVMSG sent from a user, local or remote.
+ * The dest variable contains a User* if target_type is TYPE_USER and a Channel*
* if target_type is TYPE_CHANNEL.
+ * The difference between this event and OnUserPreMessage is that delivery is gauranteed,
+ * the message has already been vetted. In the case of the other two methods, a later module may stop your
+ * message. This also differs from OnUserMessage which occurs AFTER the message has been sent.
* @param user The user sending the message
* @param dest The target of the message
* @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
* @param text the text being sent by the user
* @param status The status being used, e.g. NOTICE @#chan has status== '@', 0 to send to everyone.
+ * @param exempt_list A list of users not to send to. For channel messages, this will usually contain just the sender.
*/
- virtual void OnUserNotice(userrec* user, void* dest, int target_type, const std::string &text, char status, const CUList &exempt_list);
+ virtual void OnText(User* user, void* dest, int target_type, const std::string &text, char status, CUList &exempt_list);
/** Called after every MODE command sent from a user
- * The dest variable contains a userrec* if target_type is TYPE_USER and a chanrec*
- * if target_type is TYPE_CHANNEL. The text variable contains the remainder of the
- * mode string after the target, e.g. "+wsi" or "+ooo nick1 nick2 nick3".
+ * Either the usertarget or the chantarget variable contains the target of the modes,
+ * the actual target will have a non-NULL pointer.
+ * All changed modes are available in the changelist object.
* @param user The user sending the MODEs
- * @param dest The target of the modes (userrec* or chanrec*)
- * @param target_type The type of target (TYPE_USER or TYPE_CHANNEL)
- * @param text The actual modes and their parameters if any
+ * @param usertarget The target user of the modes, NULL if the target is a channel
+ * @param chantarget The target channel of the modes, NULL if the target is a user
+ * @param changelist The changed modes.
+ * @param processflags Flags passed to ModeParser::Process(), see ModeParser::ModeProcessFlags
+ * for the possible flags.
+ * @param output_mode Changed modes, including '+' and '-' characters, not including any parameters
*/
- virtual void OnMode(userrec* user, void* dest, int target_type, const std::string &text);
-
- /** Allows modules to alter or create server descriptions
- * Whenever a module requires a server description, for example for display in
- * WHOIS, this function is called in all modules. You may change or define the
- * description given in std::string &description. If you do, this description
- * will be shown in the WHOIS fields.
- * @param servername The servername being searched for
- * @param description Alterable server description for this server
- */
- virtual void OnGetServerDescription(const std::string &servername,std::string &description);
+ virtual void OnMode(User* user, User* usertarget, Channel* chantarget, const Modes::ChangeList& changelist, ModeParser::ModeProcessFlag processflags, const std::string& output_mode);
/** Allows modules to synchronize data which relates to users during a netburst.
* When this function is called, it will be called from the module which implements
- * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
- * is given in Module* proto, so that you may call its methods such as ProtoSendMode
- * (see below). This function will be called for every user visible on your side
- * of the burst, allowing you to for example set modes, etc. Do not use this call to
- * synchronize data which you have stored using class Extensible -- There is a specialist
- * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
+ * the linking protocol. This currently is m_spanningtree.so.
+ * This function will be called for every user visible on your side
+ * of the burst, allowing you to for example set modes, etc.
* @param user The user being syncronized
- * @param proto A pointer to the module handling network protocol
- * @param opaque An opaque pointer set by the protocol module, should not be modified!
+ * @param server The target of the burst
*/
- virtual void OnSyncUser(userrec* user, Module* proto, void* opaque);
+ virtual void OnSyncUser(User* user, ProtocolServer& server);
/** Allows modules to synchronize data which relates to channels during a netburst.
* When this function is called, it will be called from the module which implements
- * the linking protocol. This currently is m_spanningtree.so. A pointer to this module
- * is given in Module* proto, so that you may call its methods such as ProtoSendMode
- * (see below). This function will be called for every user visible on your side
- * of the burst, allowing you to for example set modes, etc. Do not use this call to
- * synchronize data which you have stored using class Extensible -- There is a specialist
- * function OnSyncUserMetaData and OnSyncChannelMetaData for this!
- *
- * For a good example of how to use this function, please see src/modules/m_chanprotect.cpp
+ * the linking protocol. This currently is m_spanningtree.so.
+ * This function will be called for every channel visible on your side of the burst,
+ * allowing you to for example set modes, etc.
*
* @param chan The channel being syncronized
- * @param proto A pointer to the module handling network protocol
- * @param opaque An opaque pointer set by the protocol module, should not be modified!
- */
- virtual void OnSyncChannel(chanrec* chan, Module* proto, void* opaque);
-
- /* Allows modules to syncronize metadata related to channels over the network during a netburst.
- * Whenever the linking module wants to send out data, but doesnt know what the data
- * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
- * this method is called.You should use the ProtoSendMetaData function after you've
- * correctly decided how the data should be represented, to send the metadata on its way if it belongs
- * to your module. For a good example of how to use this method, see src/modules/m_swhois.cpp.
- * @param chan The channel whos metadata is being syncronized
- * @param proto A pointer to the module handling network protocol
- * @param opaque An opaque pointer set by the protocol module, should not be modified!
- * @param extname The extensions name which is being searched for
- */
- virtual void OnSyncChannelMetaData(chanrec* chan, Module* proto,void* opaque, const std::string &extname);
-
- /* Allows modules to syncronize metadata related to users over the network during a netburst.
- * Whenever the linking module wants to send out data, but doesnt know what the data
- * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
- * this method is called. You should use the ProtoSendMetaData function after you've
- * correctly decided how the data should be represented, to send the metadata on its way if
- * if it belongs to your module.
- * @param user The user whos metadata is being syncronized
- * @param proto A pointer to the module handling network protocol
- * @param opaque An opaque pointer set by the protocol module, should not be modified!
- * @param extname The extensions name which is being searched for
- */
- virtual void OnSyncUserMetaData(userrec* user, Module* proto,void* opaque, const std::string &extname);
-
- /* Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
- * Whenever the linking module wants to send out data, but doesnt know what the data
- * represents (e.g. it is Extensible metadata, added to a userrec or chanrec by a module) then
- * this method is called. You should use the ProtoSendMetaData function after you've
- * correctly decided how the data should be represented, to send the metadata on its way if
- * if it belongs to your module.
- * @param proto A pointer to the module handling network protocol
- * @param opaque An opaque pointer set by the protocol module, should not be modified!
- */
- virtual void OnSyncOtherMetaData(Module* proto, void* opaque);
+ * @param server The target of the burst
+ */
+ virtual void OnSyncChannel(Channel* chan, ProtocolServer& server);
+
+ /** Allows modules to syncronize metadata not related to users or channels, over the network during a netburst.
+ * When the linking module has finished sending all data it wanted to send during a netburst, then
+ * this method is called. You should use the SendMetaData() function after you've
+ * correctly decided how the data should be represented, to send the data.
+ * @param server The target of the burst
+ */
+ virtual void OnSyncNetwork(ProtocolServer& server);
/** Allows module data, sent via ProtoSendMetaData, to be decoded again by a receiving module.
* Please see src/modules/m_swhois.cpp for a working example of how to use this method call.
- * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
- * @param target The chanrec* or userrec* that data should be added to
+ * @param target The Channel* or User* that data should be added to
* @param extname The extension name which is being sent
* @param extdata The extension data, encoded at the other end by an identical module through OnSyncChannelMetaData or OnSyncUserMetaData
*/
- virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata);
-
- /** Implemented by modules which provide the ability to link servers.
- * These modules will implement this method, which allows transparent sending of servermodes
- * down the network link as a broadcast, without a module calling it having to know the format
- * of the MODE command before the actual mode string.
- *
- * More documentation to follow soon. Please see src/modules/m_chanprotect.cpp for examples
- * of how to use this function.
- *
- * @param opaque An opaque pointer set by the protocol module, should not be modified!
- * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
- * @param target The chanrec* or userrec* that modes should be sent for
- * @param modeline The modes and parameters to be sent
- */
- virtual void ProtoSendMode(void* opaque, int target_type, void* target, const std::string &modeline);
-
- /** Implemented by modules which provide the ability to link servers.
- * These modules will implement this method, which allows metadata (extra data added to
- * user and channel records using class Extensible, Extensible::Extend, etc) to be sent
- * to other servers on a netburst and decoded at the other end by the same module on a
- * different server.
- *
- * More documentation to follow soon. Please see src/modules/m_swhois.cpp for example of
- * how to use this function.
- * @param opaque An opaque pointer set by the protocol module, should not be modified!
- * @param target_type The type of item to decode data for, TYPE_USER or TYPE_CHANNEL
- * @param target The chanrec* or userrec* that metadata should be sent for
- * @param extname The extension name to send metadata for
- * @param extdata Encoded data for this extension name, which will be encoded at the oppsite end by an identical module using OnDecodeMetaData
- */
- virtual void ProtoSendMetaData(void* opaque, int target_type, void* target, const std::string &extname, const std::string &extdata);
-
- /** Called after every WALLOPS command.
- * @param user The user sending the WALLOPS
- * @param text The content of the WALLOPS message
- */
- virtual void OnWallops(userrec* user, const std::string &text);
+ virtual void OnDecodeMetaData(Extensible* target, const std::string &extname, const std::string &extdata);
/** Called whenever a user's hostname is changed.
* This event triggers after the host has been set.
* @param user The user whos host is being changed
* @param newhost The new hostname being set
*/
- virtual void OnChangeHost(userrec* user, const std::string &newhost);
+ virtual void OnChangeHost(User* user, const std::string &newhost);
/** Called whenever a user's GECOS (realname) is changed.
* This event triggers after the name has been set.
* @param user The user who's GECOS is being changed
* @param gecos The new GECOS being set on the user
*/
- virtual void OnChangeName(userrec* user, const std::string &gecos);
-
- /** Called whenever a gline is added by a local user.
- * This method is triggered after the line is added.
- * @param duration The duration of the line in seconds
- * @param source The sender of the line
- * @param reason The reason text to be displayed
- * @param hostmask The hostmask to add
- */
- virtual void OnAddGLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
+ virtual void OnChangeName(User* user, const std::string &gecos);
- /** Called whenever a zline is added by a local user.
- * This method is triggered after the line is added.
- * @param duration The duration of the line in seconds
- * @param source The sender of the line
- * @param reason The reason text to be displayed
- * @param ipmask The hostmask to add
- */
- virtual void OnAddZLine(long duration, userrec* source, const std::string &reason, const std::string &ipmask);
-
- /** Called whenever a kline is added by a local user.
- * This method is triggered after the line is added.
- * @param duration The duration of the line in seconds
- * @param source The sender of the line
- * @param reason The reason text to be displayed
- * @param hostmask The hostmask to add
- */
- virtual void OnAddKLine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
-
- /** Called whenever a qline is added by a local user.
- * This method is triggered after the line is added.
- * @param duration The duration of the line in seconds
- * @param source The sender of the line
- * @param reason The reason text to be displayed
- * @param nickmask The hostmask to add
+ /** Called whenever a user's IDENT is changed.
+ * This event triggers after the name has been set.
+ * @param user The user who's IDENT is being changed
+ * @param ident The new IDENT being set on the user
*/
- virtual void OnAddQLine(long duration, userrec* source, const std::string &reason, const std::string &nickmask);
+ virtual void OnChangeIdent(User* user, const std::string &ident);
- /** Called whenever a eline is added by a local user.
+ /** Called whenever an xline is added by a local user.
* This method is triggered after the line is added.
- * @param duration The duration of the line in seconds
- * @param source The sender of the line
- * @param reason The reason text to be displayed
- * @param hostmask The hostmask to add
- */
- virtual void OnAddELine(long duration, userrec* source, const std::string &reason, const std::string &hostmask);
-
- /** Called whenever a gline is deleted.
- * This method is triggered after the line is deleted.
- * @param source The user removing the line
- * @param hostmask The hostmask to delete
- */
- virtual void OnDelGLine(userrec* source, const std::string &hostmask);
-
- /** Called whenever a zline is deleted.
- * This method is triggered after the line is deleted.
- * @param source The user removing the line
- * @param hostmask The hostmask to delete
+ * @param source The sender of the line or NULL for local server
+ * @param line The xline being added
*/
- virtual void OnDelZLine(userrec* source, const std::string &ipmask);
+ virtual void OnAddLine(User* source, XLine* line);
- /** Called whenever a kline is deleted.
+ /** Called whenever an xline is deleted MANUALLY. See OnExpireLine for expiry.
* This method is triggered after the line is deleted.
- * @param source The user removing the line
- * @param hostmask The hostmask to delete
+ * @param source The user removing the line or NULL for local server
+ * @param line the line being deleted
*/
- virtual void OnDelKLine(userrec* source, const std::string &hostmask);
-
- /** Called whenever a qline is deleted.
- * This method is triggered after the line is deleted.
- * @param source The user removing the line
- * @param hostmask The hostmask to delete
- */
- virtual void OnDelQLine(userrec* source, const std::string &nickmask);
+ virtual void OnDelLine(User* source, XLine* line);
- /** Called whenever a eline is deleted.
+ /** Called whenever an xline expires.
* This method is triggered after the line is deleted.
- * @param source The user removing the line
- * @param hostmask The hostmask to delete
+ * @param line The line being deleted.
*/
- virtual void OnDelELine(userrec* source, const std::string &hostmask);
+ virtual void OnExpireLine(XLine *line);
/** Called before your module is unloaded to clean up Extensibles.
* This method is called once for every user and channel on the network,
* so that when your module unloads it may clear up any remaining data
* in the form of Extensibles added using Extensible::Extend().
* If the target_type variable is TYPE_USER, then void* item refers to
- * a userrec*, otherwise it refers to a chanrec*.
+ * a User*, otherwise it refers to a Channel*.
* @param target_type The type of item being cleaned
* @param item A pointer to the item's class
*/
/** Called after any nickchange, local or remote. This can be used to track users after nickchanges
* have been applied. Please note that although you can see remote nickchanges through this function, you should
- * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
+ * NOT make any changes to the User if the user is a remote user as this may cause a desnyc.
* check user->server before taking any action (including returning nonzero from the method).
* Because this method is called after the nickchange is taken place, no return values are possible
* to indicate forbidding of the nick change. Use OnUserPreNick for this.
* @param user The user changing their nick
* @param oldnick The old nickname of the user before the nickchange
*/
- virtual void OnUserPostNick(userrec* user, const std::string &oldnick);
-
- /** Called before an action which requires a channel privilage check.
- * This function is called before many functions which check a users status on a channel, for example
- * before opping a user, deopping a user, kicking a user, etc.
- * There are several values for access_type which indicate for what reason access is being checked.
- * These are:<br><br>
- * AC_KICK (0) - A user is being kicked<br>
- * AC_DEOP (1) - a user is being deopped<br>
- * AC_OP (2) - a user is being opped<br>
- * AC_VOICE (3) - a user is being voiced<br>
- * AC_DEVOICE (4) - a user is being devoiced<br>
- * AC_HALFOP (5) - a user is being halfopped<br>
- * AC_DEHALFOP (6) - a user is being dehalfopped<br>
- * AC_INVITE () - a user is being invited<br>
- * AC_GENERAL_MODE (8) - a user channel mode is being changed<br><br>
- * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
- * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
- * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
- * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
- * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
- * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
- * @param source The source of the access check
- * @param dest The destination of the access check
- * @param channel The channel which is being checked
- * @param access_type See above
- */
- virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type);
+ virtual void OnUserPostNick(User* user, const std::string &oldnick);
+
+ /** Called before any mode change, to allow a single access check for
+ * a full mode change (use OnRawMode to check individual modes)
+ *
+ * Returning MOD_RES_ALLOW will skip prefix level checks, but can be overridden by
+ * OnRawMode for each individual mode
+ *
+ * @param source the user making the mode change
+ * @param dest the user destination of the umode change (NULL if a channel mode)
+ * @param channel the channel destination of the mode change
+ * @param parameters raw mode parameters; parameters[0] is the user/channel being changed
+ */
+ virtual ModResult OnPreMode(User* source, User* dest, Channel* channel, const std::vector<std::string>& parameters);
/** Called when a 005 numeric is about to be output.
* The module should modify the 005 numeric if needed to indicate its features.
- * @param output The 005 string to be modified if neccessary.
- */
- virtual void On005Numeric(std::string &output);
+ * @param tokens The 005 map to be modified if neccessary.
+ */
+ virtual void On005Numeric(std::map<std::string, std::string>& tokens);
/** Called when a client is disconnected by KILL.
* If a client is killed by a server, e.g. a nickname collision or protocol error,
* @param reason The kill reason
* @return 1 to prevent the kill, 0 to allow
*/
- virtual int OnKill(userrec* source, userrec* dest, const std::string &reason);
-
- /** Called when an oper wants to disconnect a remote user via KILL
- * @param source The user sending the KILL
- * @param dest The user being killed
- * @param reason The kill reason
- */
- virtual void OnRemoteKill(userrec* source, userrec* dest, const std::string &reason);
+ virtual ModResult OnKill(User* source, User* dest, const std::string &reason);
/** Called whenever a module is loaded.
* mod will contain a pointer to the module, and string will contain its name,
* absolutely neccessary (e.g. a module that extends the features of another
* module).
* @param mod A pointer to the new module
- * @param name The new module's filename
*/
- virtual void OnLoadModule(Module* mod,const std::string &name);
+ virtual void OnLoadModule(Module* mod);
/** Called whenever a module is unloaded.
* mod will contain a pointer to the module, and string will contain its name,
* absolutely neccessary (e.g. a module that extends the features of another
* module).
* @param mod Pointer to the module being unloaded (still valid)
- * @param name The filename of the module being unloaded
*/
- virtual void OnUnloadModule(Module* mod,const std::string &name);
+ virtual void OnUnloadModule(Module* mod);
/** Called once every five seconds for background processing.
* This timer can be used to control timed features. Its period is not accurate
* method returns, it will be passed an invalid pointer to the user object and crash!)
* @param command The command being executed
* @param parameters An array of array of characters containing the parameters for the command
- * @param pcnt The nuimber of parameters passed to the command
* @param user the user issuing the command
* @param validated True if the command has passed all checks, e.g. it is recognised, has enough parameters, the user has permission to execute it, etc.
+ * You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs).
* @param original_line The entire original line as passed to the parser from the user
* @return 1 to block the command, 0 to allow
*/
- virtual int OnPreCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, bool validated, const std::string &original_line);
+ virtual ModResult OnPreCommand(std::string &command, std::vector<std::string>& parameters, LocalUser *user, bool validated, const std::string &original_line);
/** Called after any command has been executed.
* This event occurs for all registered commands, wether they are registered in the core,
* provided.
* @param command The command being executed
* @param parameters An array of array of characters containing the parameters for the command
- * @param pcnt The nuimber of parameters passed to the command
* @param user the user issuing the command
* @param result The return code given by the command handler, one of CMD_SUCCESS or CMD_FAILURE
* @param original_line The entire original line as passed to the parser from the user
*/
- virtual void OnPostCommand(const std::string &command, const char** parameters, int pcnt, userrec *user, CmdResult result, const std::string &original_line);
+ virtual void OnPostCommand(Command* command, const std::vector<std::string>& parameters, LocalUser* user, CmdResult result, const std::string& original_line);
+
+ /** Called when a user is first connecting, prior to starting DNS lookups, checking initial
+ * connect class, or accepting any commands.
+ */
+ virtual void OnUserInit(LocalUser* user);
/** Called to check if a user who is connecting can now be allowed to register
* If any modules return false for this function, the user is held in the waiting
* @param user The user to check
* @return true to indicate readiness, false if otherwise
*/
- virtual bool OnCheckReady(userrec* user);
+ virtual ModResult OnCheckReady(LocalUser* user);
/** Called whenever a user is about to register their connection (e.g. before the user
* is sent the MOTD etc). Modules can use this method if they are performing a function
* @param user The user registering
* @return 1 to indicate user quit, 0 to continue
*/
- virtual int OnUserRegister(userrec* user);
+ virtual ModResult OnUserRegister(LocalUser* user);
/** Called whenever a user joins a channel, to determine if invite checks should go ahead or not.
* This method will always be called for each join, wether or not the channel is actually +i, and
* @param chan The channel being joined
* @return 1 to explicitly allow the join, 0 to proceed as normal
*/
- virtual int OnCheckInvite(userrec* user, chanrec* chan);
+ virtual ModResult OnCheckInvite(User* user, Channel* chan);
+
+ /** Called whenever a mode character is processed.
+ * Return 1 from this function to block the mode character from being processed entirely.
+ * @param user The user who is sending the mode
+ * @param chan The channel the mode is being sent to (or NULL if a usermode)
+ * @param mh The mode handler for the mode being changed
+ * @param param The parameter for the mode or an empty string
+ * @param adding true of the mode is being added, false if it is being removed
+ * @return ACR_DENY to deny the mode, ACR_DEFAULT to do standard mode checking, and ACR_ALLOW
+ * to skip all permission checking. Please note that for remote mode changes, your return value
+ * will be ignored!
+ */
+ virtual ModResult OnRawMode(User* user, Channel* chan, ModeHandler* mh, const std::string& param, bool adding);
/** Called whenever a user joins a channel, to determine if key checks should go ahead or not.
* This method will always be called for each join, wether or not the channel is actually +k, and
* return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
* @param user The user joining the channel
* @param chan The channel being joined
+ * @param keygiven The key given on joining the channel.
* @return 1 to explicitly allow the join, 0 to proceed as normal
*/
- virtual int OnCheckKey(userrec* user, chanrec* chan, const std::string &keygiven);
+ virtual ModResult OnCheckKey(User* user, Channel* chan, const std::string &keygiven);
/** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not.
* This method will always be called for each join, wether or not the channel is actually +l, and
* @param chan The channel being joined
* @return 1 to explicitly allow the join, 0 to proceed as normal
*/
- virtual int OnCheckLimit(userrec* user, chanrec* chan);
+ virtual ModResult OnCheckLimit(User* user, Channel* chan);
- /** Called whenever a user joins a channel, to determine if banlist checks should go ahead or not.
- * This method will always be called for each join, wether or not the user actually matches a channel ban, and
- * determines the outcome of an if statement around the whole section of ban checking code.
- * return 1 to explicitly allow the join to go ahead or 0 to ignore the event.
- * @param user The user joining the channel
- * @param chan The channel being joined
- * @return 1 to explicitly allow the join, 0 to proceed as normal
+ /**
+ * Checks for a user's ban from the channel
+ * @param user The user to check
+ * @param chan The channel to check in
+ * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
+ * ban check, or MOD_RES_PASSTHRU to check bans normally
+ */
+ virtual ModResult OnCheckChannelBan(User* user, Channel* chan);
+
+ /**
+ * Checks for a user's match of a single ban
+ * @param user The user to check for match
+ * @param chan The channel on which the match is being checked
+ * @param mask The mask being checked
+ * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
+ * ban check, or MOD_RES_PASSTHRU to check bans normally
+ */
+ virtual ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask);
+
+ /** Checks for a match on a given extban type
+ * @return MOD_RES_DENY to mark as banned, MOD_RES_ALLOW to skip the
+ * ban check, or MOD_RES_PASSTHRU to check bans normally
*/
- virtual int OnCheckBan(userrec* user, chanrec* chan);
+ virtual ModResult OnExtBanCheck(User* user, Channel* chan, char type);
/** Called on all /STATS commands
* This method is triggered for all /STATS use, including stats symbols handled by the core.
* work when remote STATS queries are received.
* @return 1 to block the /STATS from being processed by the core, 0 to allow it
*/
- virtual int OnStats(char symbol, userrec* user, string_list &results);
+ virtual ModResult OnStats(char symbol, User* user, string_list &results);
/** Called whenever a change of a local users displayed host is attempted.
* Return 1 to deny the host change, or 0 to allow it.
* @param newhost The new hostname
* @return 1 to deny the host change, 0 to allow
*/
- virtual int OnChangeLocalUserHost(userrec* user, const std::string &newhost);
+ virtual ModResult OnChangeLocalUserHost(LocalUser* user, const std::string &newhost);
/** Called whenever a change of a local users GECOS (fullname field) is attempted.
* return 1 to deny the name change, or 0 to allow it.
* @param newhost The new GECOS
* @return 1 to deny the GECOS change, 0 to allow
*/
- virtual int OnChangeLocalUserGECOS(userrec* user, const std::string &newhost);
+ virtual ModResult OnChangeLocalUserGECOS(LocalUser* user, const std::string &newhost);
- /** Called whenever a topic is changed by a local user.
- * Return 1 to deny the topic change, or 0 to allow it.
+ /** Called before a topic is changed.
+ * Return 1 to deny the topic change, 0 to check details on the change, -1 to let it through with no checks
+ * As with other 'pre' events, you should only ever block a local event.
* @param user The user changing the topic
* @param chan The channels who's topic is being changed
* @param topic The actual topic text
- * @param 1 to block the topic change, 0 to allow
+ * @return 1 to block the topic change, 0 to allow
*/
- virtual int OnLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic);
+ virtual ModResult OnPreTopicChange(User* user, Channel* chan, const std::string &topic);
- /** Called whenever a local topic has been changed.
- * To block topic changes you must use OnLocalTopicChange instead.
+ /** Called whenever a topic has been changed.
+ * To block topic changes you must use OnPreTopicChange instead.
* @param user The user changing the topic
* @param chan The channels who's topic is being changed
* @param topic The actual topic text
*/
- virtual void OnPostLocalTopicChange(userrec* user, chanrec* chan, const std::string &topic);
+ virtual void OnPostTopicChange(User* user, Channel* chan, const std::string &topic);
- /** Called whenever an Event class is sent to all module by another module.
- * Please see the documentation of Event::Send() for further information. The Event sent can
- * always be assumed to be non-NULL, you should *always* check the value of Event::GetEventID()
- * before doing anything to the event data, and you should *not* change the event data in any way!
+ /** Called whenever an Event class is sent to all modules by another module.
+ * You should *always* check the value of Event::id to determine the event type.
* @param event The Event class being received
*/
- virtual void OnEvent(Event* event);
+ virtual void OnEvent(Event& event);
- /** Called whenever a Request class is sent to your module by another module.
- * Please see the documentation of Request::Send() for further information. The Request sent
- * can always be assumed to be non-NULL, you should not change the request object or its data.
- * Your method may return arbitary data in the char* result which the requesting module
- * may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc).
- * @param request The Request class being received
- */
- virtual char* OnRequest(Request* request);
-
- /** Called whenever an oper password is to be compared to what a user has input.
+ /** Called whenever a password check is to be made. Replaces the old OldOperCompare API.
* The password field (from the config file) is in 'password' and is to be compared against
- * 'input'. This method allows for encryption of oper passwords and much more besides.
- * You should return a nonzero value if you want to allow the comparison or zero if you wish
- * to do nothing.
- * @param password The oper's password
- * @param input The password entered
- * @param tagnumber The tag number (from the configuration file) of this oper's tag
- * @return 1 to match the passwords, 0 to do nothing. -1 to not match, and not continue.
+ * 'input'. This method allows for encryption of passwords (oper, connect:allow, die/restart, etc).
+ * You should return a nonzero value to override the normal comparison, or zero to pass it on.
+ * @param ex The object that's causing the authentication (User* for \<oper> \<connect:allow> etc, Server* for \<link>).
+ * @param password The password from the configuration file (the password="" value).
+ * @param input The password entered by the user or whoever.
+ * @param hashtype The hash value from the config
+ * @return 0 to do nothing (pass on to next module/default), 1 == password is OK, -1 == password is not OK
*/
- virtual int OnOperCompare(const std::string &password, const std::string &input, int tagnumber);
+ virtual ModResult OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype);
/** Called whenever a user is given usermode +o, anywhere on the network.
* You cannot override this and prevent it from happening as it is already happened and
* servermodes out to reverse mode changes.
* @param user The user who is opering
*/
- virtual void OnGlobalOper(userrec* user);
+ virtual void OnGlobalOper(User* user);
/** Called after a user has fully connected and all modules have executed OnUserConnect
* This event is informational only. You should not change any user information in this
* This is called for both local and remote users.
* @param user The user who is connecting
*/
- virtual void OnPostConnect(userrec* user);
+ virtual void OnPostConnect(User* user);
- /** Called whenever a ban is added to a channel's list.
- * Return a non-zero value to 'eat' the mode change and prevent the ban from being added.
- * @param source The user adding the ban
- * @param channel The channel the ban is being added to
- * @param banmask The ban mask being added
- * @return 1 to block the ban, 0 to continue as normal
- */
- virtual int OnAddBan(userrec* source, chanrec* channel,const std::string &banmask);
-
- /** Called whenever a ban is removed from a channel's list.
- * Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.
- * @param source The user deleting the ban
- * @param channel The channel the ban is being deleted from
- * @param banmask The ban mask being deleted
- * @return 1 to block the unban, 0 to continue as normal
- */
- virtual int OnDelBan(userrec* source, chanrec* channel,const std::string &banmask);
-
- /** Called immediately after any connection is accepted. This is intended for raw socket
- * processing (e.g. modules which wrap the tcp connection within another library) and provides
- * no information relating to a user record as the connection has not been assigned yet.
- * There are no return values from this call as all modules get an opportunity if required to
- * process the connection.
+ /** Called when a port accepts a connection
+ * Return MOD_RES_ACCEPT if you have used the file descriptor.
* @param fd The file descriptor returned from accept()
- * @param ip The IP address of the connecting user
- * @param localport The local port number the user connected to
- */
- virtual void OnRawSocketAccept(int fd, const std::string &ip, int localport);
-
- /** Called immediately before any write() operation on a user's socket in the core. Because
- * this event is a low level event no user information is associated with it. It is intended
- * for use by modules which may wrap connections within another API such as SSL for example.
- * return a non-zero result if you have handled the write operation, in which case the core
- * will not call write().
- * @param fd The file descriptor of the socket
- * @param buffer A char* buffer being written
- * @param Number of characters to write
- * @return Number of characters actually written or 0 if you didn't handle the operation
+ * @param sock The socket connection for the new user
+ * @param client The client IP address and port
+ * @param server The server IP address and port
*/
- virtual int OnRawSocketWrite(int fd, const char* buffer, int count);
+ virtual ModResult OnAcceptConnection(int fd, ListenSocket* sock, irc::sockets::sockaddrs* client, irc::sockets::sockaddrs* server);
- /** Called immediately before any socket is closed. When this event is called, shutdown()
- * has not yet been called on the socket.
- * @param fd The file descriptor of the socket prior to close()
+ /** Called whenever a user sets away or returns from being away.
+ * The away message is available as a parameter, but should not be modified.
+ * At this stage, it has already been copied into the user record.
+ * If awaymsg is empty, the user is returning from away.
+ * @param user The user setting away
+ * @param awaymsg The away message of the user, or empty if returning from away
+ * @return nonzero if the away message should be blocked - should ONLY be nonzero for LOCAL users (IS_LOCAL) (no output is returned by core)
*/
- virtual void OnRawSocketClose(int fd);
-
- virtual void OnRawSocketConnect(int fd);
-
- /** Called immediately before any read() operation on a client socket in the core.
- * This occurs AFTER the select() or poll() so there is always data waiting to be read
- * when this event occurs.
- * Your event should return 1 if it has handled the reading itself, which prevents the core
- * just using read(). You should place any data read into buffer, up to but NOT GREATER THAN
- * the value of count. The value of readresult must be identical to an actual result that might
- * be returned from the read() system call, for example, number of bytes read upon success,
- * 0 upon EOF or closed socket, and -1 for error. If your function returns a nonzero value,
- * you MUST set readresult.
- * @param fd The file descriptor of the socket
- * @param buffer A char* buffer being read to
- * @param count The size of the buffer
- * @param readresult The amount of characters read, or 0
- * @return nonzero if the event was handled, in which case readresult must be valid on exit
- */
- virtual int OnRawSocketRead(int fd, char* buffer, unsigned int count, int &readresult);
-
- /** Called whenever a user sets away.
- * This method has no parameter for the away message, as it is available in the
- * user record as userrec::awaymsg.
- */
- virtual void OnSetAway(userrec* user);
-
- /** Called when a user cancels their away state.
- */
- virtual void OnCancelAway(userrec* user);
-
- /** Called whenever a NAMES list is requested.
- * You can produce the nameslist yourself, overriding the current list,
- * and if you do you must return 1. If you do not handle the names list,
- * return 0.
- */
- virtual int OnUserList(userrec* user, chanrec* Ptr);
+ virtual ModResult OnSetAway(User* user, const std::string &awaymsg);
/** Called whenever a line of WHOIS output is sent to a user.
* You may change the numeric and the text of the output by changing
* the values numeric and text, but you cannot change the user the
- * numeric is sent to. You may however change the user's userrec values.
+ * numeric is sent to. You may however change the user's User values.
* @param user The user the numeric is being sent to
* @param dest The user being WHOISed
* @param numeric The numeric of the line being sent
* @return nonzero to drop the line completely so that the user does not
* receive it, or zero to allow the line to be sent.
*/
- virtual int OnWhoisLine(userrec* user, userrec* dest, int &numeric, std::string &text);
+ virtual ModResult OnWhoisLine(User* user, User* dest, int &numeric, std::string &text);
/** Called at intervals for modules to garbage-collect any hashes etc.
* Certain data types such as hash_map 'leak' buckets, which must be
*/
virtual void OnGarbageCollect();
- virtual void OnBufferFlushed(userrec* user);
-};
+ /** Called when a user's connect class is being matched
+ * @return MOD_RES_ALLOW to force the class to match, MOD_RES_DENY to forbid it, or
+ * MOD_RES_PASSTHRU to allow normal matching (by host/port).
+ */
+ virtual ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass);
+#ifdef INSPIRCD_ENABLE_TESTSUITE
+ /** Add test suite hooks here. These are used for testing functionality of a module
+ * via the --testsuite debugging parameter.
+ */
+ virtual void OnRunTestSuite();
+#endif
-#define CONF_NOT_A_NUMBER 0x000010
-#define CONF_NOT_UNSIGNED 0x000080
-#define CONF_VALUE_NOT_FOUND 0x000100
-#define CONF_FILE_NOT_FOUND 0x000200
+ /** Called for every item in a NAMES list, so that modules may reformat portions of it as they see fit.
+ * For example NAMESX, channel mode +u and +I, and UHNAMES.
+ * @param issuer The user who is going to receive the NAMES list being built
+ * @param item The channel member being considered for inclusion
+ * @param prefixes The prefix character(s) to display, initially set to the prefix char of the most powerful
+ * prefix mode the member has, can be changed
+ * @param nick The nick to display, initially set to the member's nick, can be changed
+ * @return Return MOD_RES_PASSTHRU to allow the member to be displayed, MOD_RES_DENY to cause them to be
+ * excluded from this NAMES list
+ */
+ virtual ModResult OnNamesListItem(User* issuer, Membership* item, std::string& prefixes, std::string& nick);
+ virtual ModResult OnNumeric(User* user, unsigned int numeric, const std::string &text);
-/** Allows reading of values from configuration files
- * This class allows a module to read from either the main configuration file (inspircd.conf) or from
- * a module-specified configuration file. It may either be instantiated with one parameter or none.
- * Constructing the class using one parameter allows you to specify a path to your own configuration
- * file, otherwise, inspircd.conf is read.
- */
-class ConfigReader : public classbase
-{
- protected:
- InspIRCd* ServerInstance;
- /** The contents of the configuration file
- * This protected member should never be accessed by a module (and cannot be accessed unless the
- * core is changed). It will contain a pointer to the configuration file data with unneeded data
- * (such as comments) stripped from it.
- */
- ConfigDataHash* data;
- std::ostringstream* errorlog;;
- /** Used to store errors
- */
- bool privatehash; // If we're using our own config data hash or not.
- bool readerror;
- long error;
-
- public:
- /** Default constructor.
- * This constructor initialises the ConfigReader class to read the inspircd.conf file
- * as specified when running ./configure.
+ /** Called whenever a result from /WHO is about to be returned
+ * @param source The user running the /WHO query
+ * @param params The parameters to the /WHO query
+ * @param user The user that this line of the query is about
+ * @param memb The member shown in this line, NULL if no channel is in this line
+ * @param line The raw line to send; modifiable, if empty no line will be returned.
*/
- ConfigReader(InspIRCd* Instance);
- /** Overloaded constructor.
- * This constructor initialises the ConfigReader class to read a user-specified config file
+ virtual void OnSendWhoLine(User* source, const std::vector<std::string>& params, User* user, Membership* memb, std::string& line);
+
+ /** Called whenever a local user's IP is set for the first time, or when a local user's IP changes due to
+ * a module like m_cgiirc changing it.
+ * @param user The user whose IP is being set
*/
- ConfigReader(InspIRCd* Instance, const std::string &filename);
- /** Default destructor.
- * This method destroys the ConfigReader class.
- */
- ~ConfigReader();
-
- /** Retrieves a value from the config file.
- * This method retrieves a value from the config file. Where multiple copies of the tag
- * exist in the config file, index indicates which of the values to retrieve.
- */
- std::string ReadValue(const std::string &tag, const std::string &name, int index, bool allow_linefeeds = false);
- /** Retrieves a value from the config file.
- * This method retrieves a value from the config file. Where multiple copies of the tag
- * exist in the config file, index indicates which of the values to retrieve. If the
- * tag is not found the default value is returned instead.
- */
- std::string ReadValue(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool allow_linefeeds = false);
-
- /** Retrieves a boolean value from the config file.
- * This method retrieves a boolean value from the config file. Where multiple copies of the tag
- * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
- * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
- */
- bool ReadFlag(const std::string &tag, const std::string &name, int index);
- /** Retrieves a boolean value from the config file.
- * This method retrieves a boolean value from the config file. Where multiple copies of the tag
- * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
- * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
- * If the tag is not found, the default value is used instead.
- */
- bool ReadFlag(const std::string &tag, const std::string &name, const std::string &default_value, int index);
-
- /** Retrieves an integer value from the config file.
- * This method retrieves an integer value from the config file. Where multiple copies of the tag
- * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
- * values in the tag will cause the objects error value to be set, and any call to GetError() will
- * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
- * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
- * will return CONF_NOT_UNSIGNED
- */
- long ReadInteger(const std::string &tag, const std::string &name, int index, bool needs_unsigned);
- /** Retrieves an integer value from the config file.
- * This method retrieves an integer value from the config file. Where multiple copies of the tag
- * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
- * values in the tag will cause the objects error value to be set, and any call to GetError() will
- * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
- * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
- * will return CONF_NOT_UNSIGNED. If the tag is not found, the default value is used instead.
- */
- long ReadInteger(const std::string &tag, const std::string &name, const std::string &default_value, int index, bool needs_unsigned);
-
- /** Returns the last error to occur.
- * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
- * A call to GetError() resets the error flag back to 0.
- */
- long GetError();
- /** Counts the number of times a given tag appears in the config file.
- * This method counts the number of times a tag appears in a config file, for use where
- * there are several tags of the same kind, e.g. with opers and connect types. It can be
- * used with the index value of ConfigReader::ReadValue to loop through all copies of a
- * multiple instance tag.
- */
- int Enumerate(const std::string &tag);
- /** Returns true if a config file is valid.
- * This method is partially implemented and will only return false if the config
- * file does not exist or could not be opened.
- */
- bool Verify();
- /** Dumps the list of errors in a config file to an output location. If bail is true,
- * then the program will abort. If bail is false and user points to a valid user
- * record, the error report will be spooled to the given user by means of NOTICE.
- * if bool is false AND user is false, the error report will be spooled to all opers
- * by means of a NOTICE to all opers.
- */
- void DumpErrors(bool bail,userrec* user);
-
- /** Returns the number of items within a tag.
- * For example if the tag was <test tag="blah" data="foo"> then this
- * function would return 2. Spaces and newlines both qualify as valid seperators
- * between values.
- */
- int EnumerateValues(const std::string &tag, int index);
+ virtual void OnSetUserIP(LocalUser* user);
};
+/** A list of modules
+ */
+typedef std::vector<Module*> IntModuleList;
+/** An event handler iterator
+ */
+typedef IntModuleList::iterator EventHandlerIter;
-/** Caches a text file into memory and can be used to retrieve lines from it.
- * This class contains methods for read-only manipulation of a text file in memory.
- * Either use the constructor type with one parameter to load a file into memory
- * at construction, or use the LoadFile method to load a file.
+/** ModuleManager takes care of all things module-related
+ * in the core.
*/
-class FileReader : public classbase
+class CoreExport ModuleManager : public fakederef<ModuleManager>
{
- InspIRCd* ServerInstance;
- /** The file contents
+ public:
+ typedef std::vector<ServiceProvider*> ServiceList;
+
+ private:
+ /** Holds a string describing the last module error to occur
*/
- file_cache fc;
+ std::string LastModuleError;
- unsigned long contentsize;
+ /** List of loaded modules and shared object/dll handles
+ * keyed by module name
+ */
+ std::map<std::string, Module*> Modules;
- void CalcSize();
+ enum {
+ PRIO_STATE_FIRST,
+ PRIO_STATE_AGAIN,
+ PRIO_STATE_LAST
+ } prioritizationState;
+
+ /** Internal unload module hook */
+ bool CanUnload(Module*);
+
+ /** Loads all core modules (cmd_*)
+ */
+ void LoadCoreModules(std::map<std::string, ServiceList>& servicemap);
+
+ /** Calls the Prioritize() method in all loaded modules
+ * @return True if all went well, false if a dependency loop was detected
+ */
+ bool PrioritizeHooks();
public:
- /** Default constructor.
- * This method does not load any file into memory, you must use the LoadFile method
- * after constructing the class this way.
+ typedef std::map<std::string, Module*> ModuleMap;
+
+ /** Event handler hooks.
+ * This needs to be public to be used by FOREACH_MOD and friends.
*/
- FileReader(InspIRCd* Instance);
+ IntModuleList EventHandlers[I_END];
- /** Secondary constructor.
- * This method initialises the class with a file loaded into it ready for GetLine and
- * and other methods to be called. If the file could not be loaded, FileReader::FileSize
- * returns 0.
+ /** List of data services keyed by name */
+ std::multimap<std::string, ServiceProvider*> DataProviders;
+
+ /** A list of ServiceProviders waiting to be registered.
+ * Non-NULL when constructing a Module, NULL otherwise.
+ * When non-NULL ServiceProviders add themselves to this list on creation and the core
+ * automatically registers them (that is, call AddService()) after the Module is constructed,
+ * and before Module::init() is called.
+ * If a service is created after the construction of the Module (for example in init()) it
+ * has to be registered manually.
*/
- FileReader(InspIRCd* Instance, const std::string &filename);
+ ServiceList* NewServices;
- /** Default destructor.
- * This deletes the memory allocated to the file.
+ /** Simple, bog-standard, boring constructor.
*/
- ~FileReader();
+ ModuleManager();
- /** Used to load a file.
- * This method loads a file into the class ready for GetLine and
- * and other methods to be called. If the file could not be loaded, FileReader::FileSize
- * returns 0.
+ /** Destructor
*/
- void LoadFile(const std::string &filename);
+ ~ModuleManager();
- /** Returns the whole content of the file as std::string
+ /** Change the priority of one event in a module.
+ * Each module event has a list of modules which are attached to that event type.
+ * If you wish to be called before or after other specific modules, you may use this
+ * method (usually within void Module::Prioritize()) to set your events priority.
+ * You may use this call in other methods too, however, this is not supported behaviour
+ * for a module.
+ * @param mod The module to change the priority of
+ * @param i The event to change the priority of
+ * @param s The state you wish to use for this event. Use one of
+ * PRIO_FIRST to set the event to be first called, PRIO_LAST to
+ * set it to be the last called, or PRIO_BEFORE and PRIORITY_AFTER
+ * to set it to be before or after one or more other modules.
+ * @param which If PRIO_BEFORE or PRIORITY_AFTER is set in parameter 's',
+ * then this contains a the module that your module must be placed before
+ * or after.
*/
- std::string Contents();
+ bool SetPriority(Module* mod, Implementation i, Priority s, Module* which = NULL);
+
+ /** Backwards compat interface */
+ inline bool SetPriority(Module* mod, Implementation i, Priority s, Module** dptr)
+ {
+ return SetPriority(mod, i, s, *dptr);
+ }
- /** Returns the entire size of the file as std::string
+ /** Change the priority of all events in a module.
+ * @param mod The module to set the priority of
+ * @param s The priority of all events in the module.
+ * Note that with this method, it is not possible to effectively use
+ * PRIO_BEFORE or PRIORITY_AFTER, you should use the more fine tuned
+ * SetPriority method for this, where you may specify other modules to
+ * be prioritized against.
*/
- unsigned long ContentSize();
+ bool SetPriority(Module* mod, Priority s);
- /** Returns true if the file exists
- * This function will return false if the file could not be opened.
+ /** Attach an event to a module.
+ * You may later detatch the event with ModuleManager::Detach().
+ * If your module is unloaded, all events are automatically detatched.
+ * @param i Event type to attach
+ * @param mod Module to attach event to
+ * @return True if the event was attached
*/
- bool Exists();
-
- /** Retrieve one line from the file.
- * This method retrieves one line from the text file. If an empty non-NULL string is returned,
- * the index was out of bounds, or the line had no data on it.
+ bool Attach(Implementation i, Module* mod);
+
+ /** Detatch an event from a module.
+ * This is not required when your module unloads, as the core will
+ * automatically detatch your module from all events it is attached to.
+ * @param i Event type to detach
+ * @param mod Module to detach event from
+ * @return True if the event was detached
*/
- std::string GetLine(int x);
+ bool Detach(Implementation i, Module* mod);
- /** Returns the size of the file in lines.
- * This method returns the number of lines in the read file. If it is 0, no lines have been
- * read into memory, either because the file is empty or it does not exist, or cannot be
- * opened due to permission problems.
+ /** Attach an array of events to a module
+ * @param i Event types (array) to attach
+ * @param mod Module to attach events to
+ * @param sz The size of the implementation array
*/
- int FileSize();
-};
+ void Attach(Implementation* i, Module* mod, size_t sz);
+ /** Detach all events from a module (used on unload)
+ * @param mod Module to detach from
+ */
+ void DetachAll(Module* mod);
-/** Instantiates classes inherited from Module.
- * This class creates a class inherited from type Module, using new. This is to allow for modules
- * to create many different variants of Module, dependent on architecture, configuration, etc.
- * In most cases, the simple class shown in the example module m_foobar.so will suffice for most
- * modules.
- */
-class ModuleFactory : public classbase
-{
- public:
- /** The default constructor does nothing.
+ /** Attach all events to a module (used on module load)
+ * @param mod Module to attach to all events
*/
- ModuleFactory() { }
- /** The default destructor does nothing
+ void AttachAll(Module* mod);
+
+ /** Returns text describing the last module error
+ * @return The last error message to occur
*/
- virtual ~ModuleFactory() { }
- /** Creates a new module.
- * Your inherited class of ModuleFactory must return a pointer to your Module class
- * using this method.
+ std::string& LastError();
+
+ /** Load a given module file
+ * @param filename The file to load
+ * @param defer Defer module init (loading many modules)
+ * @return True if the module was found and loaded
*/
- virtual Module * CreateModule(InspIRCd* Me) = 0;
+ bool Load(const std::string& filename, bool defer = false);
+
+ /** Unload a given module file. Note that the module will not be
+ * completely gone until the cull list has finished processing.
+ *
+ * @return true on success; if false, LastError will give a reason
+ */
+ bool Unload(Module* module);
+
+ /** Run an asynchronous reload of the given module. When the reload is
+ * complete, the callback will be run with true if the reload succeeded
+ * and false if it did not.
+ */
+ void Reload(Module* module, HandlerBase1<void, bool>* callback);
+
+ /** Called by the InspIRCd constructor to load all modules from the config file.
+ */
+ void LoadAll();
+ void UnloadAll();
+ void DoSafeUnload(Module*);
+
+ /** Find a module by name, and return a Module* to it.
+ * This is preferred over iterating the module lists yourself.
+ * @param name The module name to look up
+ * @return A pointer to the module, or NULL if the module cannot be found
+ */
+ Module* Find(const std::string &name);
+
+ /** Register a service provided by a module */
+ void AddService(ServiceProvider&);
+
+ /** Unregister a service provided by a module */
+ void DelService(ServiceProvider&);
+
+ /** Register all services in a given ServiceList
+ * @param list The list containing the services to register
+ */
+ void AddServices(const ServiceList& list);
+
+ inline void AddServices(ServiceProvider** list, int count)
+ {
+ for(int i=0; i < count; i++)
+ AddService(*list[i]);
+ }
+
+ /** Find a service by name.
+ * If multiple modules provide a given service, the first one loaded will be chosen.
+ */
+ ServiceProvider* FindService(ServiceType Type, const std::string& name);
+
+ template<typename T> inline T* FindDataService(const std::string& name)
+ {
+ return static_cast<T*>(FindService(SERVICE_DATA, name));
+ }
+
+ /** Get a map of all loaded modules keyed by their name
+ * @return A ModuleMap containing all loaded modules
+ */
+ const ModuleMap& GetModules() const { return Modules; }
};
-/** A DLLFactory (designed to load shared objects) containing a ModuleFactory.
+/** Do not mess with these functions unless you know the C preprocessor
+ * well enough to explain why they are needed. The order is important.
*/
-typedef DLLFactory<ModuleFactory> ircd_module;
+#define MODULE_INIT_STR MODULE_INIT_STR_FN_2(MODULE_INIT_SYM)
+#define MODULE_INIT_STR_FN_2(x) MODULE_INIT_STR_FN_1(x)
+#define MODULE_INIT_STR_FN_1(x) #x
+#define MODULE_INIT_SYM MODULE_INIT_SYM_FN_2(INSPIRCD_VERSION_MAJ, INSPIRCD_VERSION_API)
+#define MODULE_INIT_SYM_FN_2(x,y) MODULE_INIT_SYM_FN_1(x,y)
+#define MODULE_INIT_SYM_FN_1(x,y) inspircd_module_ ## x ## _ ## y
+
+#ifdef PURE_STATIC
+
+struct AllCommandList {
+ typedef Command* (*fn)(Module*);
+ AllCommandList(fn cmd);
+};
+#define COMMAND_INIT(x) static Command* MK_ ## x(Module* m) { return new x(m); } \
+ static const AllCommandList PREP_ ## x(&MK_ ## x);
+
+struct AllModuleList {
+ typedef Module* (*fn)();
+ fn init;
+ std::string name;
+ AllModuleList(fn mod, const std::string& Name);
+};
-/** A list of loaded Modules
- */
-typedef std::vector<Module*> ModuleList;
+#define MODULE_INIT(x) static Module* MK_ ## x() { return new x; } \
+ static const AllModuleList PREP_ ## x(&MK_ ## x, MODNAME ".so");
+
+#else
-/** A list of loaded ModuleFactories
+/** This definition is used as shorthand for the various classes
+ * and functions needed to make a module loadable by the OS.
+ * It defines the class factory and external init_module function.
*/
-typedef std::vector<ircd_module*> FactoryList;
+#ifdef _WIN32
+
+#define MODULE_INIT(y) \
+ extern "C" DllExport Module * MODULE_INIT_SYM() \
+ { \
+ return new y; \
+ } \
+ BOOLEAN WINAPI DllMain(HINSTANCE hDllHandle, DWORD nReason, LPVOID Reserved) \
+ { \
+ switch ( nReason ) \
+ { \
+ case DLL_PROCESS_ATTACH: \
+ case DLL_PROCESS_DETACH: \
+ break; \
+ } \
+ return TRUE; \
+ }
+
+#else
+
+#define MODULE_INIT(y) \
+ extern "C" DllExport Module * MODULE_INIT_SYM() \
+ { \
+ return new y; \
+ } \
+ extern "C" DllExport const char inspircd_src_version[] = INSPIRCD_VERSION " " INSPIRCD_REVISION;
+#endif
+
+#define COMMAND_INIT(c) MODULE_INIT(CommandModule<c>)
#endif
projects / user / henk / code / inspircd.git / blobdiff