1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * Inspire is copyright (C) 2002-2004 ChatSpike-Dev.
7 * <brain@chatspike.net>
8 * <Craig@chatspike.net>
10 * Written by Craig Edwards, Craig McLure, and others.
11 * This program is free but copyrighted software; see
12 * the file COPYING for details.
14 * ---------------------------------------------------
29 // used with OnExtendedMode() method of modules
35 // used with OnAccessCheck() method of modules
37 #define ACR_DEFAULT 0 // Do default action (act as if the module isnt even loaded)
38 #define ACR_DENY 1 // deny the action
39 #define ACR_ALLOW 2 // allow the action
41 #define AC_KICK 0 // a user is being kicked
42 #define AC_DEOP 1 // a user is being deopped
43 #define AC_OP 2 // a user is being opped
44 #define AC_VOICE 3 // a user is being voiced
45 #define AC_DEVOICE 4 // a user is being devoiced
46 #define AC_HALFOP 5 // a user is being halfopped
47 #define AC_DEHALFOP 6 // a user is being dehalfopped
48 #define AC_INVITE 7 // a user is being invited
49 #define AC_GENERAL_MODE 8 // a user channel mode is being changed
51 // used to define a set of behavior bits for a module
53 #define VF_STATIC 1 // module is static, cannot be /unloadmodule'd
54 #define VF_VENDOR 2 // module is a vendor module (came in the original tarball, not 3rd party)
55 #define VF_SERVICEPROVIDER 4 // module provides a service to other modules (can be a dependency)
56 #define VF_COMMON 8 // module needs to be common on all servers in a mesh to link
65 /** Low level definition of a FileReader classes file cache area
67 typedef std::deque<std::string> file_cache;
68 typedef file_cache string_list;
70 /** Holds a list of users in a channel
72 typedef std::deque<userrec*> chanuserlist;
75 // This #define allows us to call a method in all
76 // loaded modules in a readable simple way, e.g.:
77 // 'FOREACH_MOD OnConnect(user);'
79 #define FOREACH_MOD for (int i = 0; i <= MODCOUNT; i++) modules[i]->
81 // This define is similar to the one above but returns a result in MOD_RESULT.
82 // The first module to return a nonzero result is the value to be accepted,
83 // and any modules after are ignored.
85 // *********************************************************************************************
87 #define FOREACH_RESULT(x) { MOD_RESULT = 0; \
88 for (int i = 0; i <= MODCOUNT; i++) { \
89 int res = modules[i]->x ; \
97 // *********************************************************************************************
99 #define FD_MAGIC_NUMBER -42
101 extern void createcommand(char* cmd, handlerfunc f, char flags, int minparams, char* source);
102 extern void server_mode(char **parameters, int pcnt, userrec *user);
104 // class Version holds the version information of a Module, returned
105 // by Module::GetVersion (thanks RD)
107 /** Holds a module's Version information
108 * The four members (set by the constructor only) indicate details as to the version number
109 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
111 class Version : public classbase
114 const int Major, Minor, Revision, Build, Flags;
115 Version(int major, int minor, int revision, int build, int flags);
118 /** Holds /ADMIN data
119 * This class contains the admin details of the local server. It is constructed by class Server,
120 * and has three read-only values, Name, Email and Nick that contain the specified values for the
121 * server where the module is running.
123 class Admin : public classbase
126 const std::string Name, Email, Nick;
127 Admin(std::string name, std::string email, std::string nick);
130 /** Base class for all InspIRCd modules
131 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
132 * its methods will be called when irc server events occur. class inherited from module must be
133 * instantiated by the ModuleFactory class (see relevent section) for the plugin to be initialised.
135 class Module : public classbase
139 /** Default constructor
140 * creates a module class
144 /** Default destructor
145 * destroys a module class
149 /** Returns the version number of a Module.
150 * The method should return a Version object with its version information assigned via
153 virtual Version GetVersion();
155 /** Called when a user connects.
156 * The details of the connecting user are available to you in the parameter userrec *user
158 virtual void OnUserConnect(userrec* user);
160 /** Called when a user quits.
161 * The details of the exiting user are available to you in the parameter userrec *user
163 virtual void OnUserQuit(userrec* user);
165 /** Called when a user joins a channel.
166 * The details of the joining user are available to you in the parameter userrec *user,
167 * and the details of the channel they have joined is available in the variable chanrec *channel
169 virtual void OnUserJoin(userrec* user, chanrec* channel);
171 /** Called when a user parts a channel.
172 * The details of the leaving user are available to you in the parameter userrec *user,
173 * and the details of the channel they have left is available in the variable chanrec *channel
175 virtual void OnUserPart(userrec* user, chanrec* channel);
177 /** Called before a packet is transmitted across the irc network between two irc servers.
178 * This allows you to easily represent it in the correct ways to implement encryption, compression,
179 * digital signatures and anything else you may want to add. This should be regarded as a pre-processor
180 * and will be called before ANY other operations within the ircd core program.
182 virtual void OnPacketTransmit(std::string &data, std::string serv);
184 /** Called after a packet is received from another irc server.
185 * This allows you to easily represent it in the correct ways to implement encryption, compression,
186 * digital signatures and anything else you may want to add. This should be regarded as a pre-processor
187 * and will be called immediately after the packet is received but before any other operations with the
190 virtual void OnPacketReceive(std::string &data, std::string serv);
192 /** Called on rehash.
193 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
194 * system. You should use it to reload any files so that your module keeps in step with the
195 * rest of the application.
197 virtual void OnRehash();
199 /** Called when a raw command is transmitted or received.
200 * This method is the lowest level of handler available to a module. It will be called with raw
201 * data which is passing through a connected socket. If you wish, you may munge this data by changing
202 * the string parameter "raw". If you do this, after your function exits it will immediately be
203 * cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where
204 * inbound is set to true) the value of user will be the userrec of the connection sending the
205 * data. This is not possible for outbound data because the data may be being routed to multiple targets.
207 virtual void OnServerRaw(std::string &raw, bool inbound, userrec* user);
209 /** Called whenever an extended mode is to be processed.
210 * The type parameter is MT_SERVER, MT_CLIENT or MT_CHANNEL, dependent on where the mode is being
211 * changed. mode_on is set when the mode is being set, in which case params contains a list of
212 * parameters for the mode as strings. If mode_on is false, the mode is being removed, and parameters
213 * may contain the parameters for the mode, dependent on wether they were defined when a mode handler
214 * was set up with Server::AddExtendedMode
215 * If the mode is a channel mode, target is a chanrec*, and if it is a user mode, target is a userrec*.
216 * You must cast this value yourself to make use of it.
218 virtual int OnExtendedMode(userrec* user, void* target, char modechar, int type, bool mode_on, string_list ¶ms);
220 /** Called whenever a user is about to join a channel, before any processing is done.
221 * Returning a value of 1 from this function stops the process immediately, causing no
222 * output to be sent to the user by the core. If you do this you must produce your own numerics,
223 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
224 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
228 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
229 * record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of
230 * processing on the actual channel record at this point, however the channel NAME will still be passed in
231 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
233 virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname);
236 /** Called whenever a user opers locally.
237 * The userrec will contain the oper mode 'o' as this function is called after any modifications
238 * are made to the user's structure by the core.
240 virtual void OnOper(userrec* user);
242 /** Called whenever a user types /INFO.
243 * The userrec will contain the information of the user who typed the command. Modules may use this
244 * method to output their own credits in /INFO (which is the ircd's version of an about box).
245 * It is purposefully not possible to modify any info that has already been output, or halt the list.
246 * You must write a 371 numeric to the user, containing your info in the following format:
248 * <nick> :information here
250 virtual void OnInfo(userrec* user);
252 /** Called whenever a /WHOIS is performed on a local user.
253 * The source parameter contains the details of the user who issued the WHOIS command, and
254 * the dest parameter contains the information of the user they are whoising.
256 virtual void OnWhois(userrec* source, userrec* dest);
258 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
259 * Returning 1 from this function stops the process immediately, causing no
260 * output to be sent to the user by the core. If you do this you must produce your own numerics,
261 * notices etc. This is useful for modules which may want to filter invites to channels.
263 virtual int OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel);
265 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
266 * Returning any nonzero value from this function stops the process immediately, causing no
267 * output to be sent to the user by the core. If you do this you must produce your own numerics,
268 * notices etc. This is useful for modules which may want to filter or redirect messages.
269 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
270 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
271 * of where the message is destined to be sent.
273 virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text);
275 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
276 * Returning any nonzero value from this function stops the process immediately, causing no
277 * output to be sent to the user by the core. If you do this you must produce your own numerics,
278 * notices etc. This is useful for modules which may want to filter or redirect messages.
279 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
280 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
281 * of where the message is destined to be sent.
282 * You may alter the message text as you wish before relinquishing control to the next module
283 * in the chain, and if no other modules block the text this altered form of the text will be sent out
284 * to the user and possibly to other servers.
286 virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text);
288 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
289 * Please note that although you can see remote nickchanges through this function, you should
290 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
291 * check user->server before taking any action (including returning nonzero from the method).
292 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
293 * module to generate some meaninful output.
295 virtual int OnUserPreNick(userrec* user, std::string newnick);
297 /** Called after any nickchange, local or remote. This can be used to track users after nickchanges
298 * have been applied. Please note that although you can see remote nickchanges through this function, you should
299 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
300 * check user->server before taking any action (including returning nonzero from the method).
301 * Because this method is called after the nickchange is taken place, no return values are possible
302 * to indicate forbidding of the nick change. Use OnUserPreNick for this.
304 virtual void OnUserPostNick(userrec* user, std::string oldnick);
306 /** Called before an action which requires a channel privilage check.
307 * This function is called before many functions which check a users status on a channel, for example
308 * before opping a user, deopping a user, kicking a user, etc.
309 * There are several values for access_type which indicate for what reason access is being checked.
311 * AC_KICK (0) - A user is being kicked<br>
312 * AC_DEOP (1) - a user is being deopped<br>
313 * AC_OP (2) - a user is being opped<br>
314 * AC_VOICE (3) - a user is being voiced<br>
315 * AC_DEVOICE (4) - a user is being devoiced<br>
316 * AC_HALFOP (5) - a user is being halfopped<br>
317 * AC_DEHALFOP (6) - a user is being dehalfopped<br>
318 * AC_INVITE (7) - a user is being invited<br>
319 * AC_GENERAL_MODE (8) - a user channel mode is being changed<br><br>
320 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
321 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
322 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
323 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
324 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
325 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
327 virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type);
329 /** Called during a netburst to sync user data.
330 * This is called during the netburst on a per-user basis. You should use this call to up any special
331 * user-related things which are implemented by your module, e.g. sending listmodes. You may return
332 * multiple commands in the string_list.
334 virtual string_list OnUserSync(userrec* user);
336 /** Called during a netburst to sync channel data.
337 * This is called during the netburst on a per-channel basis. You should use this call to up any special
338 * channel-related things which are implemented by your module, e.g. sending listmodes. You may return
339 * multiple commands in the string_list.
341 virtual string_list OnChannelSync(chanrec* chan);
343 /** Called when a 005 numeric is about to be output.
344 * The module should modify the 005 numeric if needed to indicate its features.
346 virtual void On005Numeric(std::string &output);
348 /** Called when a client is disconnected by KILL.
349 * If a client is killed by a server, e.g. a nickname collision or protocol error,
351 * Return 1 from this function to prevent the kill, and 0 from this function to allow
352 * it as normal. If you prevent the kill no output will be sent to the client, it is
353 * down to your module to generate this information.
354 * NOTE: It is NOT advisable to stop kills which originate from servers. If you do
355 * so youre risking race conditions, desyncs and worse!
357 virtual int OnKill(userrec* source, userrec* dest, std::string reason);
359 /** Called whenever a module is loaded.
360 * mod will contain a pointer to the module, and string will contain its name,
361 * for example m_widgets.so. This function is primary for dependency checking,
362 * your module may decide to enable some extra features if it sees that you have
363 * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly
364 * recommended that modules do *NOT* bail if they cannot satisfy dependencies,
365 * but instead operate under reduced functionality, unless the dependency is
366 * absolutely neccessary (e.g. a module that extends the features of another
369 virtual void OnLoadModule(Module* mod,std::string name);
371 /** Called once every five seconds for background processing.
372 * This timer can be used to control timed features. Its period is not accurate
373 * enough to be used as a clock, but it is gauranteed to be called at least once in
374 * any five second period, directly from the main loop of the server.
376 virtual void OnBackgroundTimer(time_t curtime);
378 /** Called whenever a list is needed for a listmode.
379 * For example, when a /MODE #channel +b (without any other parameters) is called,
380 * if a module was handling +b this function would be called. The function can then
381 * output any lists it wishes to. Please note that all modules will see all mode
382 * characters to provide the ability to extend each other, so please only output
383 * a list if the mode character given matches the one(s) you want to handle.
385 virtual void OnSendList(userrec* user, chanrec* channel, char mode);
390 /** Allows server output and query functions
391 * This class contains methods which allow a module to query the state of the irc server, and produce
392 * output to users and other servers. All modules should instantiate at least one copy of this class,
393 * and use its member functions to perform their tasks.
395 class Server : public classbase
398 /** Default constructor.
399 * Creates a Server object.
402 /** Default destructor.
403 * Destroys a Server object.
407 /** Sends text to all opers.
408 * This method sends a server notice to all opers with the usermode +s.
410 virtual void SendOpers(std::string s);
411 /** Writes a log string.
412 * This method writes a line of text to the log. If the level given is lower than the
413 * level given in the configuration, this command has no effect.
415 virtual void Log(int level, std::string s);
416 /** Sends a line of text down a TCP/IP socket.
417 * This method writes a line of text to an established socket, cutting it to 510 characters
418 * plus a carriage return and linefeed if required.
420 virtual void Send(int Socket, std::string s);
421 /** Sends text from the server to a socket.
422 * This method writes a line of text to an established socket, with the servername prepended
423 * as used by numerics (see RFC 1459)
425 virtual void SendServ(int Socket, std::string s);
426 /** Sends text from a user to a socket.
427 * This method writes a line of text to an established socket, with the given user's nick/ident
428 * /host combination prepended, as used in PRIVSG etc commands (see RFC 1459)
430 virtual void SendFrom(int Socket, userrec* User, std::string s);
431 /** Sends text from a user to another user.
432 * This method writes a line of text to a user, with a user's nick/ident
433 * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459)
434 * If you specify NULL as the source, then the data will originate from the
435 * local server, e.g. instead of:
437 * :user!ident@host TEXT
439 * The format will become:
443 * Which is useful for numerics and server notices to single users, etc.
445 virtual void SendTo(userrec* Source, userrec* Dest, std::string s);
446 /** Sends text from a user to a channel (mulicast).
447 * This method writes a line of text to a channel, with the given user's nick/ident
448 * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the
449 * IncludeSender flag is set, then the text is also sent back to the user from which
450 * it originated, as seen in MODE (see RFC 1459).
452 virtual void SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender);
453 /** Returns true if two users share a common channel.
454 * This method is used internally by the NICK and QUIT commands, and the Server::SendCommon
457 virtual bool CommonChannels(userrec* u1, userrec* u2);
458 /** Sends text from a user to one or more channels (mulicast).
459 * This method writes a line of text to all users which share a common channel with a given
460 * user, with the user's nick/ident/host combination prepended, as used in PRIVMSG etc
461 * commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent
462 * back to the user from which it originated, as seen in NICK (see RFC 1459). Otherwise, it
463 * is only sent to the other recipients, as seen in QUIT.
465 virtual void SendCommon(userrec* User, std::string text,bool IncludeSender);
466 /** Sends a WALLOPS message.
467 * This method writes a WALLOPS message to all users with the +w flag, originating from the
470 virtual void SendWallops(userrec* User, std::string text);
472 /** Returns true if a nick is valid.
473 * Nicks for unregistered connections will return false.
475 virtual bool IsNick(std::string nick);
476 /** Returns a count of the number of users on a channel.
477 * This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel.
479 virtual int CountUsers(chanrec* c);
480 /** Attempts to look up a nick and return a pointer to it.
481 * This function will return NULL if the nick does not exist.
483 virtual userrec* FindNick(std::string nick);
484 /** Attempts to look up a channel and return a pointer to it.
485 * This function will return NULL if the channel does not exist.
487 virtual chanrec* FindChannel(std::string channel);
488 /** Attempts to look up a user's privilages on a channel.
489 * This function will return a string containing either @, %, +, or an empty string,
490 * representing the user's privilages upon the channel you specify.
492 virtual std::string ChanMode(userrec* User, chanrec* Chan);
493 /** Checks if a user is on a channel.
494 * This function will return true or false to indicate if user 'User' is on channel 'Chan'.
496 virtual bool IsOnChannel(userrec* User, chanrec* Chan);
497 /** Returns the server name of the server where the module is loaded.
499 virtual std::string GetServerName();
500 /** Returns the network name, global to all linked servers.
502 virtual std::string GetNetworkName();
503 /** Returns the information of the server as returned by the /ADMIN command.
504 * See the Admin class for further information of the return value. The members
505 * Admin::Nick, Admin::Email and Admin::Name contain the information for the
506 * server where the module is loaded.
508 virtual Admin GetAdmin();
509 /** Adds an extended mode letter which is parsed by a module.
510 * This allows modules to add extra mode letters, e.g. +x for hostcloak.
511 * the "type" parameter is either MT_CHANNEL, MT_CLIENT, or MT_SERVER, to
512 * indicate wether the mode is a channel mode, a client mode, or a server mode.
513 * requires_oper is used with MT_CLIENT type modes only to indicate the mode can only
514 * be set or unset by an oper. If this is used for MT_CHANNEL type modes it is ignored.
515 * params_when_on is the number of modes to expect when the mode is turned on
516 * (for type MT_CHANNEL only), e.g. with mode +k, this would have a value of 1.
517 * the params_when_off value has a similar value to params_when_on, except it indicates
518 * the number of parameters to expect when the mode is disabled. Modes which act in a similar
519 * way to channel mode +l (e.g. require a parameter to enable, but not to disable) should
520 * use this parameter. The function returns false if the mode is unavailable, and will not
521 * attempt to allocate another character, as this will confuse users. This also means that
522 * as only one module can claim a specific mode character, the core does not need to keep track
523 * of which modules own which modes, which speeds up operation of the server. In this version,
524 * a mode can have at most one parameter, attempting to use more parameters will have undefined
527 virtual bool AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off);
529 /** Adds an extended mode letter which is parsed by a module and handled in a list fashion.
530 * This call is used to implement modes like +q and +a. The characteristics of these modes are
533 * (1) They are ALWAYS on channels, not on users, therefore their type is MT_CHANNEL
535 * (2) They always take exactly one parameter when being added or removed
537 * (3) They can be set multiple times, usually on users in channels
539 * (4) The mode and its parameter are NOT stored in the channels modes structure
541 * It is down to the module handling the mode to maintain state and determine what 'items' (e.g. users,
542 * or a banlist) have the mode set on them, and process the modes at the correct times, e.g. during access
543 * checks on channels, etc. When the extended mode is triggered the OnExtendedMode method will be triggered
544 * as above. Note that the target you are given will be a channel, if for example your mode is set 'on a user'
545 * (in for example +a) you must use Server::Find to locate the user the mode is operating on.
546 * Your mode handler may return 1 to handle the mode AND tell the core to display the mode change, e.g.
547 * '+aaa one two three' in the case of the mode for 'two', or it may return -1 to 'eat' the mode change,
548 * so the above example would become '+aa one three' after processing.
550 virtual bool AddExtendedListMode(char modechar);
552 /** Adds a command to the command table.
553 * This allows modules to add extra commands into the command table. You must place a function within your
554 * module which is is of type handlerfunc:
556 * typedef void (handlerfunc) (char**, int, userrec*);
558 * void handle_kill(char **parameters, int pcnt, userrec *user)
560 * When the command is typed, the parameters will be placed into the parameters array (similar to argv) and
561 * the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters
562 * than the 'minparams' value you specified when creating the command. The *user parameter is the class of
563 * the user which caused the command to trigger, who will always have the flag you specified in 'flags' when
564 * creating the initial command. For example to create an oper only command create the commands with flags='o'.
565 * The source parameter is used for resource tracking, and should contain the name of your module (with file
566 * extension) e.g. "m_blarp.so". If you place the wrong identifier here, you can cause crashes if your module
569 virtual void AddCommand(char* cmd, handlerfunc f, char flags, int minparams, char* source);
571 /** Sends a servermode.
572 * you must format the parameters array with the target, modes and parameters for those modes.
578 * modes[0] = ChannelName;
582 * modes[2] = user->nick;
584 * Srv->SendMode(modes,3,user);
586 * The modes will originate from the server where the command was issued, however responses (e.g. numerics)
587 * will be sent to the user you provide as the third parameter.
588 * You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave
589 * your server in an unstable state!
592 virtual void SendMode(char **parameters, int pcnt, userrec *user);
594 /** Sends to all users matching a mode mask
595 * You must specify one or more usermodes as the first parameter. These can be RFC specified modes such as +i,
596 * or module provided modes, including ones provided by your own module.
597 * In the second parameter you must place a flag value which indicates wether the modes you have given will be
598 * logically ANDed or OR'ed. You may use one of either WM_AND or WM_OR.
599 * for example, if you were to use:
601 * Serv->SendToModeMask("xi", WM_OR, "m00");
603 * Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the
604 * user must have both modes set to receive the message.
606 virtual void SendToModeMask(std::string modes, int flags, std::string text);
608 /** Forces a user to join a channel.
609 * This is similar to svsjoin and can be used to implement redirection, etc.
610 * On success, the return value is a valid pointer to a chanrec* of the channel the user was joined to.
611 * On failure, the result is NULL.
613 virtual chanrec* JoinUserToChannel(userrec* user, std::string cname, std::string key);
615 /** Forces a user to part a channel.
616 * This is similar to svspart and can be used to implement redirection, etc.
617 * Although the return value of this function is a pointer to a channel record, the returned data is
618 * undefined and should not be read or written to. This behaviour may be changed in a future version.
620 virtual chanrec* PartUserFromChannel(userrec* user, std::string cname, std::string reason);
622 /** Forces a user nickchange.
623 * This command works similarly to SVSNICK, and can be used to implement Q-lines etc.
624 * If you specify an invalid nickname, the nick change will be dropped and the target user will receive
625 * the error numeric for it.
627 virtual void ChangeUserNick(userrec* user, std::string nickname);
629 /** Forces a user to quit with the specified reason.
630 * To the user, it will appear as if they typed /QUIT themselves, except for the fact that this function
631 * may bypass the quit prefix specified in the config file.
635 * Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or
636 * read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of
637 * action after calling this method is to immediately bail from your handler.
639 virtual void QuitUser(userrec* user, std::string reason);
641 /** Matches text against a glob pattern.
642 * Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com
643 * Returns true if the literal successfully matches the pattern, false if otherwise.
645 virtual bool MatchText(std::string sliteral, std::string spattern);
647 /** Calls the handler for a command, either implemented by the core or by another module.
648 * You can use this function to trigger other commands in the ircd, such as PRIVMSG, JOIN,
649 * KICK etc, or even as a method of callback. By defining command names that are untypeable
650 * for users on irc (e.g. those which contain a \r or \n) you may use them as callback identifiers.
651 * The first parameter to this method is the name of the command handler you wish to call, e.g.
652 * PRIVMSG. This will be a command handler previously registered by the core or wih AddCommand().
653 * The second parameter is an array of parameters, and the third parameter is a count of parameters
654 * in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the
655 * functiom will silently ignore it. The final parameter is the user executing the command handler,
656 * used for privilage checks, etc.
658 virtual void CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user);
660 /** Change displayed hostname of a user.
661 * You should always call this method to change a user's host rather than writing directly to the
662 * dhost member of userrec, as any change applied via this method will be propogated to any
665 virtual void ChangeHost(userrec* user, std::string host);
667 /** Change GECOS (fullname) of a user.
668 * You should always call this method to change a user's GECOS rather than writing directly to the
669 * fullname member of userrec, as any change applied via this method will be propogated to any
672 virtual void ChangeGECOS(userrec* user, std::string gecos);
674 /** Returns true if the servername you give is ulined.
675 * ULined servers have extra privilages. They are allowed to change nicknames on remote servers,
676 * change modes of clients which are on remote servers and set modes of channels where there are
677 * no channel operators for that channel on the ulined server, amongst other things. Ulined server
678 * data is also broadcast across the mesh at all times as opposed to selectively messaged in the
679 * case of normal servers, as many ulined server types (such as services) do not support meshed
680 * links and must operate in this manner.
682 virtual bool IsUlined(std::string server);
684 /** Fetches the userlist of a channel. This function must be here and not a member of userrec or
685 * chanrec due to include constraints.
687 virtual chanuserlist GetUsers(chanrec* chan);
689 /** Remove a user's connection to the irc server, but leave their client in existence in the
690 * user hash. When you call this function, the user's file descriptor will be replaced with the
691 * value of FD_MAGIC_NUMBER and their old file descriptor will be closed. This idle client will
692 * remain until it is restored with a valid file descriptor, or is removed from IRC by an operator
693 * After this call, the pointer to user will be invalid.
695 virtual bool UserToPseudo(userrec* user,std::string message);
697 /** This user takes one user, and switches their file descriptor with another user, so that one user
698 * "becomes" the other. The user in 'alive' is booted off the server with the given message. The user
699 * referred to by 'zombie' should have previously been locked with Server::ZombifyUser, otherwise
700 * stale sockets and file descriptor leaks can occur. After this call, the pointer to alive will be
701 * invalid, and the pointer to zombie will be equivalent in effect to the old pointer to alive.
703 virtual bool PseudoToUser(userrec* alive,userrec* zombie,std::string message);
706 * The G-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
707 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
708 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
709 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
712 virtual void AddGLine(long duration, std::string source, std::string reason, std::string hostmask);
715 * The Q-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
716 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
717 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
718 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
721 virtual void AddQLine(long duration, std::string source, std::string reason, std::string nickname);
724 * The Z-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
725 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
726 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
727 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
730 virtual void AddZLine(long duration, std::string source, std::string reason, std::string ipaddr);
733 * The K-line is enforced as soon as it is added.
734 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
735 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
736 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
739 virtual void AddKLine(long duration, std::string source, std::string reason, std::string hostmask);
742 * The E-line is enforced as soon as it is added.
743 * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
744 * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
745 * to indicate who or what sent the data, usually this is the nickname of a person, or a server
748 virtual void AddELine(long duration, std::string source, std::string reason, std::string hostmask);
750 /** Deletes a G-Line from all servers on the mesh
752 virtual bool DelGLine(std::string hostmask);
754 /** Deletes a Q-Line from all servers on the mesh
756 virtual bool DelQLine(std::string nickname);
758 /** Deletes a Z-Line from all servers on the mesh
760 virtual bool DelZLine(std::string ipaddr);
762 /** Deletes a local K-Line
764 virtual bool DelKLine(std::string hostmask);
766 /** Deletes a local E-Line
768 virtual bool DelELine(std::string hostmask);
770 /** Calculates a duration
771 * This method will take a string containing a formatted duration (e.g. "1w2d") and return its value
772 * as a total number of seconds. This is the same function used internally by /GLINE etc to set
775 virtual long CalcDuration(std::string duration);
777 /** Returns true if a nick!ident@host string is correctly formatted, false if otherwise.
779 virtual bool IsValidMask(std::string mask);
782 #define CONF_NOT_A_NUMBER 0x000010
783 #define CONF_NOT_UNSIGNED 0x000080
784 #define CONF_VALUE_NOT_FOUND 0x000100
785 #define CONF_FILE_NOT_FOUND 0x000200
787 /** Allows reading of values from configuration files
788 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
789 * a module-specified configuration file. It may either be instantiated with one parameter or none.
790 * Constructing the class using one parameter allows you to specify a path to your own configuration
791 * file, otherwise, inspircd.conf is read.
793 class ConfigReader : public classbase
796 /** The contents of the configuration file
797 * This protected member should never be accessed by a module (and cannot be accessed unless the
798 * core is changed). It will contain a pointer to the configuration file data with unneeded data
799 * (such as comments) stripped from it.
801 std::stringstream *cache;
802 std::stringstream *errorlog;
803 /** Used to store errors
809 /** Default constructor.
810 * This constructor initialises the ConfigReader class to read the inspircd.conf file
811 * as specified when running ./configure.
813 ConfigReader(); // default constructor reads ircd.conf
814 /** Overloaded constructor.
815 * This constructor initialises the ConfigReader class to read a user-specified config file
817 ConfigReader(std::string filename); // read a module-specific config
818 /** Default destructor.
819 * This method destroys the ConfigReader class.
822 /** Retrieves a value from the config file.
823 * This method retrieves a value from the config file. Where multiple copies of the tag
824 * exist in the config file, index indicates which of the values to retrieve.
826 std::string ReadValue(std::string tag, std::string name, int index);
827 /** Retrieves a boolean value from the config file.
828 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
829 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
830 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
832 bool ReadFlag(std::string tag, std::string name, int index);
833 /** Retrieves an integer value from the config file.
834 * This method retrieves an integer value from the config file. Where multiple copies of the tag
835 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
836 * values in the tag will cause the objects error value to be set, and any call to GetError() will
837 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
838 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
839 * will return CONF_NOT_UNSIGNED
841 long ReadInteger(std::string tag, std::string name, int index, bool needs_unsigned);
842 /** Returns the last error to occur.
843 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
844 * A call to GetError() resets the error flag back to 0.
847 /** Counts the number of times a given tag appears in the config file.
848 * This method counts the number of times a tag appears in a config file, for use where
849 * there are several tags of the same kind, e.g. with opers and connect types. It can be
850 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
851 * multiple instance tag.
853 int Enumerate(std::string tag);
854 /** Returns true if a config file is valid.
855 * This method is partially implemented and will only return false if the config
856 * file does not exist or could not be opened.
859 /** Dumps the list of errors in a config file to an output location. If bail is true,
860 * then the program will abort. If bail is false and user points to a valid user
861 * record, the error report will be spooled to the given user by means of NOTICE.
862 * if bool is false AND user is false, the error report will be spooled to all opers
863 * by means of a NOTICE to all opers.
865 void DumpErrors(bool bail,userrec* user);
867 /** Returns the number of items within a tag.
868 * For example if the tag was <test tag="blah" data="foo"> then this
869 * function would return 2. Spaces and newlines both qualify as valid seperators
872 int EnumerateValues(std::string tag, int index);
877 /** Caches a text file into memory and can be used to retrieve lines from it.
878 * This class contains methods for read-only manipulation of a text file in memory.
879 * Either use the constructor type with one parameter to load a file into memory
880 * at construction, or use the LoadFile method to load a file.
882 class FileReader : public classbase
886 /** Default constructor.
887 * This method does not load any file into memory, you must use the LoadFile method
888 * after constructing the class this way.
892 /** Secondary constructor.
893 * This method initialises the class with a file loaded into it ready for GetLine and
894 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
897 FileReader(std::string filename);
899 /** Default destructor.
900 * This deletes the memory allocated to the file.
904 /** Used to load a file.
905 * This method loads a file into the class ready for GetLine and
906 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
909 void LoadFile(std::string filename);
911 /** Returns true if the file exists
912 * This function will return false if the file could not be opened.
916 /** Retrieve one line from the file.
917 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
918 * the index was out of bounds, or the line had no data on it.
920 std::string GetLine(int x);
922 /** Returns the size of the file in lines.
923 * This method returns the number of lines in the read file. If it is 0, no lines have been
924 * read into memory, either because the file is empty or it does not exist, or cannot be
925 * opened due to permission problems.
931 /** Instantiates classes inherited from Module
932 * This class creates a class inherited from type Module, using new. This is to allow for modules
933 * to create many different variants of Module, dependent on architecture, configuration, etc.
934 * In most cases, the simple class shown in the example module m_foobar.so will suffice for most
937 class ModuleFactory : public classbase
941 virtual ~ModuleFactory() { }
942 /** Creates a new module.
943 * Your inherited class of ModuleFactory must return a pointer to your Module class
946 virtual Module * CreateModule() = 0;
950 typedef DLLFactory<ModuleFactory> ircd_module;