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
58 /** Low level definition of a FileReader classes file cache area
60 typedef std::deque<std::string> file_cache;
61 typedef file_cache string_list;
63 /** Holds a list of users in a channel
65 typedef std::deque<userrec*> chanuserlist;
68 // This #define allows us to call a method in all
69 // loaded modules in a readable simple way, e.g.:
70 // 'FOREACH_MOD OnConnect(user);'
72 #define FOREACH_MOD for (int i = 0; i <= MODCOUNT; i++) modules[i]->
74 // This define is similar to the one above but returns a result in MOD_RESULT.
75 // The first module to return a nonzero result is the value to be accepted,
76 // and any modules after are ignored.
78 // *********************************************************************************************
80 #define FOREACH_RESULT(x) { MOD_RESULT = 0; \
81 for (int i = 0; i <= MODCOUNT; i++) { \
82 int res = modules[i]->x ; \
90 // *********************************************************************************************
92 extern void createcommand(char* cmd, handlerfunc f, char flags, int minparams);
93 extern void server_mode(char **parameters, int pcnt, userrec *user);
95 // class Version holds the version information of a Module, returned
96 // by Module::GetVersion (thanks RD)
98 /** Holds a module's Version information
99 * The four members (set by the constructor only) indicate details as to the version number
100 * of a module. A class of type Version is returned by the GetVersion method of the Module class.
102 class Version : public classbase
105 const int Major, Minor, Revision, Build;
106 Version(int major, int minor, int revision, int build);
109 /** Holds /ADMIN data
110 * This class contains the admin details of the local server. It is constructed by class Server,
111 * and has three read-only values, Name, Email and Nick that contain the specified values for the
112 * server where the module is running.
114 class Admin : public classbase
117 const std::string Name, Email, Nick;
118 Admin(std::string name, std::string email, std::string nick);
121 /** Base class for all InspIRCd modules
122 * This class is the base class for InspIRCd modules. All modules must inherit from this class,
123 * its methods will be called when irc server events occur. class inherited from module must be
124 * instantiated by the ModuleFactory class (see relevent section) for the plugin to be initialised.
126 class Module : public classbase
130 /** Default constructor
131 * creates a module class
135 /** Default destructor
136 * destroys a module class
140 /** Returns the version number of a Module.
141 * The method should return a Version object with its version information assigned via
144 virtual Version GetVersion();
146 /** Called when a user connects.
147 * The details of the connecting user are available to you in the parameter userrec *user
149 virtual void OnUserConnect(userrec* user);
151 /** Called when a user quits.
152 * The details of the exiting user are available to you in the parameter userrec *user
154 virtual void OnUserQuit(userrec* user);
156 /** Called when a user joins a channel.
157 * The details of the joining user are available to you in the parameter userrec *user,
158 * and the details of the channel they have joined is available in the variable chanrec *channel
160 virtual void OnUserJoin(userrec* user, chanrec* channel);
162 /** Called when a user parts a channel.
163 * The details of the leaving user are available to you in the parameter userrec *user,
164 * and the details of the channel they have left is available in the variable chanrec *channel
166 virtual void OnUserPart(userrec* user, chanrec* channel);
168 /** Called before a packet is transmitted across the irc network between two irc servers.
169 * The packet is represented as a char*, as it should be regarded as a buffer, and not a string.
170 * This allows you to easily represent it in the correct ways to implement encryption, compression,
171 * digital signatures and anything else you may want to add. This should be regarded as a pre-processor
172 * and will be called before ANY other operations within the ircd core program.
174 virtual void OnPacketTransmit(char *p);
176 /** Called after a packet is received from another irc server.
177 * The packet is represented as a char*, as it should be regarded as a buffer, and not a string.
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 immediately after the packet is received but before any other operations with the
183 virtual void OnPacketReceive(char *p);
185 /** Called on rehash.
186 * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
187 * system. You should use it to reload any files so that your module keeps in step with the
188 * rest of the application.
190 virtual void OnRehash();
192 /** Called when a raw command is transmitted or received.
193 * This method is the lowest level of handler available to a module. It will be called with raw
194 * data which is passing through a connected socket. If you wish, you may munge this data by changing
195 * the string parameter "raw". If you do this, after your function exits it will immediately be
196 * cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where
197 * inbound is set to true) the value of user will be the userrec of the connection sending the
198 * data. This is not possible for outbound data because the data may be being routed to multiple targets.
200 virtual void OnServerRaw(std::string &raw, bool inbound, userrec* user);
202 /** Called whenever an extended mode is to be processed.
203 * The type parameter is MT_SERVER, MT_CLIENT or MT_CHANNEL, dependent on where the mode is being
204 * changed. mode_on is set when the mode is being set, in which case params contains a list of
205 * parameters for the mode as strings. If mode_on is false, the mode is being removed, and parameters
206 * may contain the parameters for the mode, dependent on wether they were defined when a mode handler
207 * was set up with Server::AddExtendedMode
208 * If the mode is a channel mode, target is a chanrec*, and if it is a user mode, target is a userrec*.
209 * You must cast this value yourself to make use of it.
211 virtual int OnExtendedMode(userrec* user, void* target, char modechar, int type, bool mode_on, string_list ¶ms);
213 /** Called whenever a user is about to join a channel, before any processing is done.
214 * Returning a value of 1 from this function stops the process immediately, causing no
215 * output to be sent to the user by the core. If you do this you must produce your own numerics,
216 * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc. Returning -1 from
217 * this function forces the join to be allowed, bypassing restrictions such as banlists, invite, keys etc.
221 * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
222 * record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of
223 * processing on the actual channel record at this point, however the channel NAME will still be passed in
224 * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
226 virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname);
229 /** Called whenever a user opers locally.
230 * The userrec will contain the oper mode 'o' as this function is called after any modifications
231 * are made to the user's structure by the core.
233 virtual void OnOper(userrec* user);
235 /** Called whenever a user types /INFO.
236 * The userrec will contain the information of the user who typed the command. Modules may use this
237 * method to output their own credits in /INFO (which is the ircd's version of an about box).
238 * It is purposefully not possible to modify any info that has already been output, or halt the list.
239 * You must write a 371 numeric to the user, containing your info in the following format:
241 * <nick> :information here
243 virtual void OnInfo(userrec* user);
245 /** Called whenever a /WHOIS is performed on a local user.
246 * The source parameter contains the details of the user who issued the WHOIS command, and
247 * the dest parameter contains the information of the user they are whoising.
249 virtual void OnWhois(userrec* source, userrec* dest);
251 /** Called whenever a user is about to invite another user into a channel, before any processing is done.
252 * Returning 1 from this function stops the process immediately, causing no
253 * output to be sent to the user by the core. If you do this you must produce your own numerics,
254 * notices etc. This is useful for modules which may want to filter invites to channels.
256 virtual int OnUserPreInvite(userrec* source,userrec* dest,chanrec* channel);
258 /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
259 * Returning any nonzero value 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 or redirect messages.
262 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
263 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
264 * of where the message is destined to be sent.
266 virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text);
268 /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
269 * Returning any nonzero value from this function stops the process immediately, causing no
270 * output to be sent to the user by the core. If you do this you must produce your own numerics,
271 * notices etc. This is useful for modules which may want to filter or redirect messages.
272 * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
273 * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
274 * of where the message is destined to be sent.
275 * You may alter the message text as you wish before relinquishing control to the next module
276 * in the chain, and if no other modules block the text this altered form of the text will be sent out
277 * to the user and possibly to other servers.
279 virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text);
281 /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
282 * Please note that although you can see remote nickchanges through this function, you should
283 * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
284 * check user->server before taking any action (including returning nonzero from the method).
285 * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
286 * module to generate some meaninful output.
287 * You may alter the message text as you wish before relinquishing control to the next module
288 * in the chain, and if no other modules block the text this altered form of the text will be sent out
289 * to the user and possibly to other servers.
291 virtual int OnUserPreNick(userrec* user, std::string newnick);
293 /** Called before an action which requires a channel privilage check.
294 * This function is called before many functions which check a users status on a channel, for example
295 * before opping a user, deopping a user, kicking a user, etc.
296 * There are several values for access_type which indicate for what reason access is being checked.
298 * AC_KICK (0) - A user is being kicked<br>
299 * AC_DEOP (1) - a user is being deopped<br>
300 * AC_OP (2) - a user is being opped<br>
301 * AC_VOICE (3) - a user is being voiced<br>
302 * AC_DEVOICE (4) - a user is being devoiced<br>
303 * AC_HALFOP (5) - a user is being halfopped<br>
304 * AC_DEHALFOP (6) - a user is being dehalfopped<br>
305 * AC_INVITE (7) - a user is being invited<br>
306 * AC_GENERAL_MODE (8) - a user channel mode is being changed<br><br>
307 * Upon returning from your function you must return either ACR_DEFAULT, to indicate the module wishes
308 * to do nothing, or ACR_DENY where approprate to deny the action, and ACR_ALLOW where appropriate to allow
309 * the action. Please note that in the case of some access checks (such as AC_GENERAL_MODE) access may be
310 * denied 'upstream' causing other checks such as AC_DEOP to not be reached. Be very careful with use of the
311 * AC_GENERAL_MODE type, as it may inadvertently override the behaviour of other modules. When the access_type
312 * is AC_GENERAL_MODE, the destination of the mode will be NULL (as it has not yet been determined).
314 virtual int OnAccessCheck(userrec* source,userrec* dest,chanrec* channel,int access_type);
316 /** Called during a netburst to sync user data.
317 * This is called during the netburst on a per-user basis. You should use this call to up any special
318 * user-related things which are implemented by your module, e.g. sending listmodes. You may return
319 * multiple commands in the string_list.
321 virtual string_list OnUserSync(userrec* user);
323 /** Called during a netburst to sync channel data.
324 * This is called during the netburst on a per-channel basis. You should use this call to up any special
325 * channel-related things which are implemented by your module, e.g. sending listmodes. You may return
326 * multiple commands in the string_list.
328 virtual string_list OnChannelSync(chanrec* chan);
332 /** Allows server output and query functions
333 * This class contains methods which allow a module to query the state of the irc server, and produce
334 * output to users and other servers. All modules should instantiate at least one copy of this class,
335 * and use its member functions to perform their tasks.
337 class Server : public classbase
340 /** Default constructor.
341 * Creates a Server object.
344 /** Default destructor.
345 * Destroys a Server object.
349 /** Sends text to all opers.
350 * This method sends a server notice to all opers with the usermode +s.
352 virtual void SendOpers(std::string s);
353 /** Writes a log string.
354 * This method writes a line of text to the log. If the level given is lower than the
355 * level given in the configuration, this command has no effect.
357 virtual void Log(int level, std::string s);
358 /** Sends a line of text down a TCP/IP socket.
359 * This method writes a line of text to an established socket, cutting it to 510 characters
360 * plus a carriage return and linefeed if required.
362 virtual void Send(int Socket, std::string s);
363 /** Sends text from the server to a socket.
364 * This method writes a line of text to an established socket, with the servername prepended
365 * as used by numerics (see RFC 1459)
367 virtual void SendServ(int Socket, std::string s);
368 /** Sends text from a user to a socket.
369 * This method writes a line of text to an established socket, with the given user's nick/ident
370 * /host combination prepended, as used in PRIVSG etc commands (see RFC 1459)
372 virtual void SendFrom(int Socket, userrec* User, std::string s);
373 /** Sends text from a user to another user.
374 * This method writes a line of text to a user, with a user's nick/ident
375 * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459)
376 * If you specify NULL as the source, then the data will originate from the
377 * local server, e.g. instead of:
379 * :user!ident@host TEXT
381 * The format will become:
385 * Which is useful for numerics and server notices to single users, etc.
387 virtual void SendTo(userrec* Source, userrec* Dest, std::string s);
388 /** Sends text from a user to a channel (mulicast).
389 * This method writes a line of text to a channel, with the given user's nick/ident
390 * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the
391 * IncludeSender flag is set, then the text is also sent back to the user from which
392 * it originated, as seen in MODE (see RFC 1459).
394 virtual void SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender);
395 /** Returns true if two users share a common channel.
396 * This method is used internally by the NICK and QUIT commands, and the Server::SendCommon
399 virtual bool CommonChannels(userrec* u1, userrec* u2);
400 /** Sends text from a user to one or more channels (mulicast).
401 * This method writes a line of text to all users which share a common channel with a given
402 * user, with the user's nick/ident/host combination prepended, as used in PRIVMSG etc
403 * commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent
404 * back to the user from which it originated, as seen in NICK (see RFC 1459). Otherwise, it
405 * is only sent to the other recipients, as seen in QUIT.
407 virtual void SendCommon(userrec* User, std::string text,bool IncludeSender);
408 /** Sends a WALLOPS message.
409 * This method writes a WALLOPS message to all users with the +w flag, originating from the
412 virtual void SendWallops(userrec* User, std::string text);
414 /** Returns true if a nick is valid.
415 * Nicks for unregistered connections will return false.
417 virtual bool IsNick(std::string nick);
418 /** Returns a count of the number of users on a channel.
419 * This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel.
421 virtual int CountUsers(chanrec* c);
422 /** Attempts to look up a nick and return a pointer to it.
423 * This function will return NULL if the nick does not exist.
425 virtual userrec* FindNick(std::string nick);
426 /** Attempts to look up a channel and return a pointer to it.
427 * This function will return NULL if the channel does not exist.
429 virtual chanrec* FindChannel(std::string channel);
430 /** Attempts to look up a user's privilages on a channel.
431 * This function will return a string containing either @, %, +, or an empty string,
432 * representing the user's privilages upon the channel you specify.
434 virtual std::string ChanMode(userrec* User, chanrec* Chan);
435 /** Checks if a user is on a channel.
436 * This function will return true or false to indicate if user 'User' is on channel 'Chan'.
438 virtual bool IsOnChannel(userrec* User, chanrec* Chan);
439 /** Returns the server name of the server where the module is loaded.
441 virtual std::string GetServerName();
442 /** Returns the network name, global to all linked servers.
444 virtual std::string GetNetworkName();
445 /** Returns the information of the server as returned by the /ADMIN command.
446 * See the Admin class for further information of the return value. The members
447 * Admin::Nick, Admin::Email and Admin::Name contain the information for the
448 * server where the module is loaded.
450 virtual Admin GetAdmin();
451 /** Adds an extended mode letter which is parsed by a module.
452 * This allows modules to add extra mode letters, e.g. +x for hostcloak.
453 * the "type" parameter is either MT_CHANNEL, MT_CLIENT, or MT_SERVER, to
454 * indicate wether the mode is a channel mode, a client mode, or a server mode.
455 * requires_oper is used with MT_CLIENT type modes only to indicate the mode can only
456 * be set or unset by an oper. If this is used for MT_CHANNEL type modes it is ignored.
457 * params_when_on is the number of modes to expect when the mode is turned on
458 * (for type MT_CHANNEL only), e.g. with mode +k, this would have a value of 1.
459 * the params_when_off value has a similar value to params_when_on, except it indicates
460 * the number of parameters to expect when the mode is disabled. Modes which act in a similar
461 * way to channel mode +l (e.g. require a parameter to enable, but not to disable) should
462 * use this parameter. The function returns false if the mode is unavailable, and will not
463 * attempt to allocate another character, as this will confuse users. This also means that
464 * as only one module can claim a specific mode character, the core does not need to keep track
465 * of which modules own which modes, which speeds up operation of the server. In this version,
466 * a mode can have at most one parameter, attempting to use more parameters will have undefined
469 virtual bool AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off);
471 /** Adds an extended mode letter which is parsed by a module and handled in a list fashion.
472 * This call is used to implement modes like +q and +a. The characteristics of these modes are
475 * (1) They are ALWAYS on channels, not on users, therefore their type is MT_CHANNEL
477 * (2) They always take exactly one parameter when being added or removed
479 * (3) They can be set multiple times, usually on users in channels
481 * (4) The mode and its parameter are NOT stored in the channels modes structure
483 * It is down to the module handling the mode to maintain state and determine what 'items' (e.g. users,
484 * or a banlist) have the mode set on them, and process the modes at the correct times, e.g. during access
485 * checks on channels, etc. When the extended mode is triggered the OnExtendedMode method will be triggered
486 * as above. Note that the target you are given will be a channel, if for example your mode is set 'on a user'
487 * (in for example +a) you must use Server::Find to locate the user the mode is operating on.
488 * Your mode handler may return 1 to handle the mode AND tell the core to display the mode change, e.g.
489 * '+aaa one two three' in the case of the mode for 'two', or it may return -1 to 'eat' the mode change,
490 * so the above example would become '+aa one three' after processing.
492 virtual bool AddExtendedListMode(char modechar);
494 /** Adds a command to the command table.
495 * This allows modules to add extra commands into the command table. You must place a function within your
496 * module which is is of type handlerfunc:
498 * typedef void (handlerfunc) (char**, int, userrec*);
500 * void handle_kill(char **parameters, int pcnt, userrec *user)
502 * When the command is typed, the parameters will be placed into the parameters array (similar to argv) and
503 * the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters
504 * than the 'minparams' value you specified when creating the command. The *user parameter is the class of
505 * the user which caused the command to trigger, who will always have the flag you specified in 'flags' when
506 * creating the initial command. For example to create an oper only command create the commands with flags='o'.
508 virtual void AddCommand(char* cmd, handlerfunc f, char flags, int minparams);
510 /** Sends a servermode.
511 * you must format the parameters array with the target, modes and parameters for those modes.
517 * modes[0] = ChannelName;
521 * modes[2] = user->nick;
523 * Srv->SendMode(modes,3,user);
525 * The modes will originate from the server where the command was issued, however responses (e.g. numerics)
526 * will be sent to the user you provide as the third parameter.
527 * You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave
528 * your server in an unstable state!
531 virtual void SendMode(char **parameters, int pcnt, userrec *user);
533 /** Sends to all users matching a mode mask
534 * You must specify one or more usermodes as the first parameter. These can be RFC specified modes such as +i,
535 * or module provided modes, including ones provided by your own module.
536 * In the second parameter you must place a flag value which indicates wether the modes you have given will be
537 * logically ANDed or OR'ed. You may use one of either WM_AND or WM_OR.
538 * for example, if you were to use:
540 * Serv->SendToModeMask("xi", WM_OR, "m00");
542 * Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the
543 * user must have both modes set to receive the message.
545 virtual void SendToModeMask(std::string modes, int flags, std::string text);
547 /** Forces a user to join a channel.
548 * This is similar to svsjoin and can be used to implement redirection, etc.
549 * On success, the return value is a valid pointer to a chanrec* of the channel the user was joined to.
550 * On failure, the result is NULL.
552 virtual chanrec* JoinUserToChannel(userrec* user, std::string cname, std::string key);
554 /** Forces a user to part a channel.
555 * This is similar to svspart and can be used to implement redirection, etc.
556 * Although the return value of this function is a pointer to a channel record, the returned data is
557 * undefined and should not be read or written to. This behaviour may be changed in a future version.
559 virtual chanrec* PartUserFromChannel(userrec* user, std::string cname, std::string reason);
561 /** Forces a user nickchange.
562 * This command works similarly to SVSNICK, and can be used to implement Q-lines etc.
563 * If you specify an invalid nickname, the nick change will be dropped and the target user will receive
564 * the error numeric for it.
566 virtual void ChangeUserNick(userrec* user, std::string nickname);
568 /** Forces a user to quit with the specified reason.
569 * To the user, it will appear as if they typed /QUIT themselves, except for the fact that this function
570 * may bypass the quit prefix specified in the config file.
574 * Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or
575 * read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of
576 * action after calling this method is to immediately bail from your handler.
578 virtual void QuitUser(userrec* user, std::string reason);
580 /** Matches text against a glob pattern.
581 * Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com
582 * Returns true if the literal successfully matches the pattern, false if otherwise.
584 virtual bool MatchText(std::string sliteral, std::string spattern);
586 /** Calls the handler for a command, either implemented by the core or by another module.
587 * You can use this function to trigger other commands in the ircd, such as PRIVMSG, JOIN,
588 * KICK etc, or even as a method of callback. By defining command names that are untypeable
589 * for users on irc (e.g. those which contain a \r or \n) you may use them as callback identifiers.
590 * The first parameter to this method is the name of the command handler you wish to call, e.g.
591 * PRIVMSG. This will be a command handler previously registered by the core or wih AddCommand().
592 * The second parameter is an array of parameters, and the third parameter is a count of parameters
593 * in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the
594 * functiom will silently ignore it. The final parameter is the user executing the command handler,
595 * used for privilage checks, etc.
597 virtual void CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user);
599 /** Change displayed hostname of a user.
600 * You should always call this method to change a user's host rather than writing directly to the
601 * dhost member of userrec, as any change applied via this method will be propogated to any
604 virtual void ChangeHost(userrec* user, std::string host);
606 /** Change GECOS (fullname) of a user.
607 * You should always call this method to change a user's GECOS rather than writing directly to the
608 * fullname member of userrec, as any change applied via this method will be propogated to any
611 virtual void ChangeGECOS(userrec* user, std::string gecos);
613 /** Returns true if the servername you give is ulined.
614 * ULined servers have extra privilages. They are allowed to change nicknames on remote servers,
615 * change modes of clients which are on remote servers and set modes of channels where there are
616 * no channel operators for that channel on the ulined server, amongst other things. Ulined server
617 * data is also broadcast across the mesh at all times as opposed to selectively messaged in the
618 * case of normal servers, as many ulined server types (such as services) do not support meshed
619 * links and must operate in this manner.
621 virtual bool IsUlined(std::string server);
623 /** Fetches the userlist of a channel. This function must be here and not a member of userrec or
624 * chanrec due to include constraints.
626 virtual chanuserlist GetUsers(chanrec* chan);
630 #define CONF_NOT_A_NUMBER 0x000010
631 #define CONF_NOT_UNSIGNED 0x000080
632 #define CONF_VALUE_NOT_FOUND 0x000100
633 #define CONF_FILE_NOT_FOUND 0x000200
635 /** Allows reading of values from configuration files
636 * This class allows a module to read from either the main configuration file (inspircd.conf) or from
637 * a module-specified configuration file. It may either be instantiated with one parameter or none.
638 * Constructing the class using one parameter allows you to specify a path to your own configuration
639 * file, otherwise, inspircd.conf is read.
641 class ConfigReader : public classbase
644 /** The contents of the configuration file
645 * This protected member should never be accessed by a module (and cannot be accessed unless the
646 * core is changed). It will contain a pointer to the configuration file data with unneeded data
647 * (such as comments) stripped from it.
649 std::stringstream *cache;
650 /** Used to store errors
656 /** Default constructor.
657 * This constructor initialises the ConfigReader class to read the inspircd.conf file
658 * as specified when running ./configure.
660 ConfigReader(); // default constructor reads ircd.conf
661 /** Overloaded constructor.
662 * This constructor initialises the ConfigReader class to read a user-specified config file
664 ConfigReader(std::string filename); // read a module-specific config
665 /** Default destructor.
666 * This method destroys the ConfigReader class.
669 /** Retrieves a value from the config file.
670 * This method retrieves a value from the config file. Where multiple copies of the tag
671 * exist in the config file, index indicates which of the values to retrieve.
673 std::string ReadValue(std::string tag, std::string name, int index);
674 /** Retrieves a boolean value from the config file.
675 * This method retrieves a boolean value from the config file. Where multiple copies of the tag
676 * exist in the config file, index indicates which of the values to retrieve. The values "1", "yes"
677 * and "true" in the config file count as true to ReadFlag, and any other value counts as false.
679 bool ReadFlag(std::string tag, std::string name, int index);
680 /** Retrieves an integer value from the config file.
681 * This method retrieves an integer value from the config file. Where multiple copies of the tag
682 * exist in the config file, index indicates which of the values to retrieve. Any invalid integer
683 * values in the tag will cause the objects error value to be set, and any call to GetError() will
684 * return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned.
685 * If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError()
686 * will return CONF_NOT_UNSIGNED
688 long ReadInteger(std::string tag, std::string name, int index, bool needs_unsigned);
689 /** Returns the last error to occur.
690 * Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition.
691 * A call to GetError() resets the error flag back to 0.
694 /** Counts the number of times a given tag appears in the config file.
695 * This method counts the number of times a tag appears in a config file, for use where
696 * there are several tags of the same kind, e.g. with opers and connect types. It can be
697 * used with the index value of ConfigReader::ReadValue to loop through all copies of a
698 * multiple instance tag.
700 int Enumerate(std::string tag);
701 /** Returns true if a config file is valid.
702 * This method is partially implemented and will only return false if the config
703 * file does not exist or could not be opened.
707 /** Returns the number of items within a tag.
708 * For example if the tag was <test tag="blah" data="foo"> then this
709 * function would return 2. Spaces and newlines both qualify as valid seperators
712 int EnumerateValues(std::string tag, int index);
717 /** Caches a text file into memory and can be used to retrieve lines from it.
718 * This class contains methods for read-only manipulation of a text file in memory.
719 * Either use the constructor type with one parameter to load a file into memory
720 * at construction, or use the LoadFile method to load a file.
722 class FileReader : public classbase
726 /** Default constructor.
727 * This method does not load any file into memory, you must use the LoadFile method
728 * after constructing the class this way.
732 /** Secondary constructor.
733 * This method initialises the class with a file loaded into it ready for GetLine and
734 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
737 FileReader(std::string filename);
739 /** Default destructor.
740 * This deletes the memory allocated to the file.
744 /** Used to load a file.
745 * This method loads a file into the class ready for GetLine and
746 * and other methods to be called. If the file could not be loaded, FileReader::FileSize
749 void LoadFile(std::string filename);
751 /** Returns true if the file exists
752 * This function will return false if the file could not be opened.
756 /** Retrieve one line from the file.
757 * This method retrieves one line from the text file. If an empty non-NULL string is returned,
758 * the index was out of bounds, or the line had no data on it.
760 std::string GetLine(int x);
762 /** Returns the size of the file in lines.
763 * This method returns the number of lines in the read file. If it is 0, no lines have been
764 * read into memory, either because the file is empty or it does not exist, or cannot be
765 * opened due to permission problems.
771 /** Instantiates classes inherited from Module
772 * This class creates a class inherited from type Module, using new. This is to allow for modules
773 * to create many different variants of Module, dependent on architecture, configuration, etc.
774 * In most cases, the simple class shown in the example module m_foobar.so will suffice for most
777 class ModuleFactory : public classbase
781 virtual ~ModuleFactory() { }
782 /** Creates a new module.
783 * Your inherited class of ModuleFactory must return a pointer to your Module class
786 virtual Module * CreateModule() = 0;
790 typedef DLLFactory<ModuleFactory> ircd_module;