]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - include/modules.h
Added m_alias module which provides command aliases.
[user/henk/code/inspircd.git] / include / modules.h
1 /*
2
3
4
5 */
6
7
8 #ifndef __PLUGIN_H
9 #define __PLUGIN_H
10
11 #define DEBUG 10
12 #define VERBOSE 20
13 #define DEFAULT 30
14 #define SPARSE 40
15 #define NONE 50
16
17 #define MT_CHANNEL 1
18 #define MT_CLIENT 2
19 #define MT_SERVER 3
20
21 #include "dynamic.h"
22 #include "base.h"
23 #include "ctables.h"
24 #include <string>
25 #include <deque>
26 #include <sstream>
27
28 /** Low level definition of a FileReader classes file cache area
29  */
30 typedef std::deque<std::string> file_cache;
31 typedef file_cache string_list;
32
33
34 // This #define allows us to call a method in all
35 // loaded modules in a readable simple way, e.g.:
36 // 'FOREACH_MOD OnConnect(user);'
37
38 #define FOREACH_MOD for (int i = 0; i <= MODCOUNT; i++) modules[i]->
39
40 // This define is similar to the one above but returns a result in MOD_RESULT.
41 // The first module to return a nonzero result is the value to be accepted,
42 // and any modules after are ignored.
43
44 // *********************************************************************************************
45
46 #define FOREACH_RESULT(x) { MOD_RESULT = 0; \
47                         for (int i = 0; i <= MODCOUNT; i++) { \
48                         int res = modules[i]->x ; \
49                         if (res) { \
50                                 MOD_RESULT = res; \
51                                 break; \
52                         } \
53                 } \
54    } 
55    
56 // *********************************************************************************************
57
58 extern void createcommand(char* cmd, handlerfunc f, char flags, int minparams);
59 extern void server_mode(char **parameters, int pcnt, userrec *user);
60
61 // class Version holds the version information of a Module, returned
62 // by Module::GetVersion (thanks RD)
63
64 /** Holds a module's Version information
65  *  The four members (set by the constructor only) indicate details as to the version number
66  *  of a module. A class of type Version is returned by the GetVersion method of the Module class.
67  */
68 class Version : public classbase
69 {
70  public:
71          const int Major, Minor, Revision, Build;
72          Version(int major, int minor, int revision, int build);
73 };
74
75 /** Holds /ADMIN data
76  *  This class contains the admin details of the local server. It is constructed by class Server,
77  *  and has three read-only values, Name, Email and Nick that contain the specified values for the
78  *  server where the module is running.
79  */
80 class Admin : public classbase
81 {
82  public:
83          const std::string Name, Email, Nick;
84          Admin(std::string name, std::string email, std::string nick);
85 };
86
87 /** Base class for all InspIRCd modules
88  *  This class is the base class for InspIRCd modules. All modules must inherit from this class,
89  *  its methods will be called when irc server events occur. class inherited from module must be
90  *  instantiated by the ModuleFactory class (see relevent section) for the plugin to be initialised.
91  */
92 class Module : public classbase
93 {
94  public:
95
96         /** Default constructor
97          * creates a module class
98          */
99         Module();
100
101         /** Default destructor
102          * destroys a module class
103          */
104         virtual ~Module();
105
106         /** Returns the version number of a Module.
107          * The method should return a Version object with its version information assigned via
108          * Version::Version
109          */
110         virtual Version GetVersion();
111
112         /** Called when a user connects.
113          * The details of the connecting user are available to you in the parameter userrec *user
114          */
115         virtual void OnUserConnect(userrec* user);
116
117         /** Called when a user quits.
118          * The details of the exiting user are available to you in the parameter userrec *user
119          */
120         virtual void OnUserQuit(userrec* user);
121
122         /** Called when a user joins a channel.
123          * The details of the joining user are available to you in the parameter userrec *user,
124          * and the details of the channel they have joined is available in the variable chanrec *channel
125          */
126         virtual void OnUserJoin(userrec* user, chanrec* channel);
127
128         /** Called when a user parts a channel.
129          * The details of the leaving user are available to you in the parameter userrec *user,
130          * and the details of the channel they have left is available in the variable chanrec *channel
131          */
132         virtual void OnUserPart(userrec* user, chanrec* channel);
133
134         /** Called before a packet is transmitted across the irc network between two irc servers.
135          * The packet is represented as a char*, as it should be regarded as a buffer, and not a string.
136          * This allows you to easily represent it in the correct ways to implement encryption, compression,
137          * digital signatures and anything else you may want to add. This should be regarded as a pre-processor
138          * and will be called before ANY other operations within the ircd core program.
139          */
140         virtual void OnPacketTransmit(char *p);
141
142         /** Called after a packet is received from another irc server.
143          * The packet is represented as a char*, as it should be regarded as a buffer, and not a string.
144          * This allows you to easily represent it in the correct ways to implement encryption, compression,
145          * digital signatures and anything else you may want to add. This should be regarded as a pre-processor
146          * and will be called immediately after the packet is received but before any other operations with the
147          * core of the ircd.
148          */
149         virtual void OnPacketReceive(char *p);
150
151         /** Called on rehash.
152          * This method is called prior to a /REHASH or when a SIGHUP is received from the operating
153          * system. You should use it to reload any files so that your module keeps in step with the
154          * rest of the application.
155          */
156         virtual void OnRehash();
157
158         /** Called when a raw command is transmitted or received.
159          * This method is the lowest level of handler available to a module. It will be called with raw
160          * data which is passing through a connected socket. If you wish, you may munge this data by changing
161          * the string parameter "raw". If you do this, after your function exits it will immediately be
162          * cut down to 510 characters plus a carriage return and linefeed. For INBOUND messages only (where
163          * inbound is set to true) the value of user will be the userrec of the connection sending the
164          * data. This is not possible for outbound data because the data may be being routed to multiple targets.
165          */
166         virtual void OnServerRaw(std::string &raw, bool inbound, userrec* user);
167
168         /** Called whenever an extended mode is to be processed.
169          * The type parameter is MT_SERVER, MT_CLIENT or MT_CHANNEL, dependent on where the mode is being
170          * changed. mode_on is set when the mode is being set, in which case params contains a list of
171          * parameters for the mode as strings. If mode_on is false, the mode is being removed, and parameters
172          * may contain the parameters for the mode, dependent on wether they were defined when a mode handler
173          * was set up with Server::AddExtendedMode
174          * If the mode is a channel mode, target is a chanrec*, and if it is a user mode, target is a userrec*.
175          * You must cast this value yourself to make use of it.
176          */
177         virtual bool OnExtendedMode(userrec* user, void* target, char modechar, int type, bool mode_on, string_list &params);
178         
179         /** Called whenever a user is about to join a channel, before any processing is done.
180          * Returning any nonzero value from this function stops the process immediately, causing no
181          * output to be sent to the user by the core. If you do this you must produce your own numerics,
182          * notices etc. This is useful for modules which may want to mimic +b, +k, +l etc.
183          *
184          * IMPORTANT NOTE!
185          *
186          * If the user joins a NEW channel which does not exist yet, OnUserPreJoin will be called BEFORE the channel
187          * record is created. This will cause chanrec* chan to be NULL. There is very little you can do in form of
188          * processing on the actual channel record at this point, however the channel NAME will still be passed in
189          * char* cname, so that you could for example implement a channel blacklist or whitelist, etc.
190          */
191         virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname);
192         
193         
194         /** Called whenever a user opers locally.
195          * The userrec will contain the oper mode 'o' as this function is called after any modifications
196          * are made to the user's structure by the core.
197          */
198         virtual void OnOper(userrec* user);
199         
200         /** Called whenever a user types /INFO.
201          * The userrec will contain the information of the user who typed the command. Modules may use this
202          * method to output their own credits in /INFO (which is the ircd's version of an about box).
203          * It is purposefully not possible to modify any info that has already been output, or halt the list.
204          * You must write a 371 numeric to the user, containing your info in the following format:
205          *
206          * <nick> :information here
207          */
208         virtual void OnInfo(userrec* user);
209         
210         /** Called whenever a /WHOIS is performed on a local user.
211          * The source parameter contains the details of the user who issued the WHOIS command, and
212          * the dest parameter contains the information of the user they are whoising.
213          */
214         virtual void OnWhois(userrec* source, userrec* dest);
215         
216         /** Called whenever a user is about to PRIVMSG A user or a channel, before any processing is done.
217          * Returning any nonzero value from this function stops the process immediately, causing no
218          * output to be sent to the user by the core. If you do this you must produce your own numerics,
219          * notices etc. This is useful for modules which may want to filter or redirect messages.
220          * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
221          * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
222          * of where the message is destined to be sent.
223          */
224         virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string text);
225
226         /** Called whenever a user is about to NOTICE A user or a channel, before any processing is done.
227          * Returning any nonzero value from this function stops the process immediately, causing no
228          * output to be sent to the user by the core. If you do this you must produce your own numerics,
229          * notices etc. This is useful for modules which may want to filter or redirect messages.
230          * target_type can be one of TYPE_USER or TYPE_CHANNEL. If the target_type value is a user,
231          * you must cast dest to a userrec* otherwise you must cast it to a chanrec*, this is the details
232          * of where the message is destined to be sent.
233          */
234         virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string text);
235         
236         /** Called before any nickchange, local or remote. This can be used to implement Q-lines etc.
237          * Please note that although you can see remote nickchanges through this function, you should
238          * NOT make any changes to the userrec if the user is a remote user as this may cause a desnyc.
239          * check user->server before taking any action (including returning nonzero from the method).
240          * If your method returns nonzero, the nickchange is silently forbidden, and it is down to your
241          * module to generate some meaninful output.
242          */
243         virtual int OnUserPreNick(userrec* user, std::string newnick);
244 };
245
246
247 /** Allows server output and query functions
248  * This class contains methods which allow a module to query the state of the irc server, and produce
249  * output to users and other servers. All modules should instantiate at least one copy of this class,
250  * and use its member functions to perform their tasks.
251  */
252 class Server : public classbase
253 {
254  public:
255         /** Default constructor.
256          * Creates a Server object.
257          */
258         Server();
259         /** Default destructor.
260          * Destroys a Server object.
261          */
262         virtual ~Server();
263
264         /** Sends text to all opers.
265          * This method sends a server notice to all opers with the usermode +s.
266          */
267         virtual void SendOpers(std::string s);
268         /** Writes a log string.
269          * This method writes a line of text to the log. If the level given is lower than the
270          * level given in the configuration, this command has no effect.
271          */
272         virtual void Log(int level, std::string s);
273         /** Sends a line of text down a TCP/IP socket.
274          * This method writes a line of text to an established socket, cutting it to 510 characters
275          * plus a carriage return and linefeed if required.
276          */
277         virtual void Send(int Socket, std::string s);
278         /** Sends text from the server to a socket.
279          * This method writes a line of text to an established socket, with the servername prepended
280          * as used by numerics (see RFC 1459)
281          */
282         virtual void SendServ(int Socket, std::string s);
283         /** Sends text from a user to a socket.
284          * This method writes a line of text to an established socket, with the given user's nick/ident
285          * /host combination prepended, as used in PRIVSG etc commands (see RFC 1459)
286          */
287         virtual void SendFrom(int Socket, userrec* User, std::string s);
288         /** Sends text from a user to another user.
289          * This method writes a line of text to a user, with a user's nick/ident
290          * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459)
291          * If you specify NULL as the source, then the data will originate from the
292          * local server, e.g. instead of:
293          *
294          * :user!ident@host TEXT
295          *
296          * The format will become:
297          *
298          * :localserver TEXT
299          *
300          * Which is useful for numerics and server notices to single users, etc.
301          */
302         virtual void SendTo(userrec* Source, userrec* Dest, std::string s);
303         /** Sends text from a user to a channel (mulicast).
304          * This method writes a line of text to a channel, with the given user's nick/ident
305          * /host combination prepended, as used in PRIVMSG etc commands (see RFC 1459). If the
306          * IncludeSender flag is set, then the text is also sent back to the user from which
307          * it originated, as seen in MODE (see RFC 1459).
308          */
309         virtual void SendChannel(userrec* User, chanrec* Channel, std::string s,bool IncludeSender);
310         /** Returns true if two users share a common channel.
311          * This method is used internally by the NICK and QUIT commands, and the Server::SendCommon
312          * method.
313          */
314         virtual bool CommonChannels(userrec* u1, userrec* u2);
315         /** Sends text from a user to one or more channels (mulicast).
316          * This method writes a line of text to all users which share a common channel with a given     
317          * user, with the user's nick/ident/host combination prepended, as used in PRIVMSG etc
318          * commands (see RFC 1459). If the IncludeSender flag is set, then the text is also sent
319          * back to the user from which it originated, as seen in NICK (see RFC 1459). Otherwise, it
320          * is only sent to the other recipients, as seen in QUIT.
321          */
322         virtual void SendCommon(userrec* User, std::string text,bool IncludeSender);
323         /** Sends a WALLOPS message.
324          * This method writes a WALLOPS message to all users with the +w flag, originating from the
325          * specified user.
326          */
327         virtual void SendWallops(userrec* User, std::string text);
328
329         /** Returns true if a nick is valid.
330          * Nicks for unregistered connections will return false.
331          */
332         virtual bool IsNick(std::string nick);
333         /** Returns a count of the number of users on a channel.
334          * This will NEVER be 0, as if the chanrec exists, it will have at least one user in the channel.
335          */
336         virtual int CountUsers(chanrec* c);
337         /** Attempts to look up a nick and return a pointer to it.
338          * This function will return NULL if the nick does not exist.
339          */
340         virtual userrec* FindNick(std::string nick);
341         /** Attempts to look up a channel and return a pointer to it.
342          * This function will return NULL if the channel does not exist.
343          */
344         virtual chanrec* FindChannel(std::string channel);
345         /** Attempts to look up a user's privilages on a channel.
346          * This function will return a string containing either @, %, +, or an empty string,
347          * representing the user's privilages upon the channel you specify.
348          */
349         virtual std::string ChanMode(userrec* User, chanrec* Chan);
350         /** Returns the server name of the server where the module is loaded.
351          */
352         virtual std::string GetServerName();
353         /** Returns the network name, global to all linked servers.
354          */
355         virtual std::string GetNetworkName();
356         /** Returns the information of the server as returned by the /ADMIN command.
357          * See the Admin class for further information of the return value. The members
358          * Admin::Nick, Admin::Email and Admin::Name contain the information for the
359          * server where the module is loaded.
360          */
361         virtual Admin GetAdmin();
362         /** Adds an extended mode letter which is parsed by a module
363          * This allows modules to add extra mode letters, e.g. +x for hostcloak.
364          * the "type" parameter is either MT_CHANNEL, MT_CLIENT, or MT_SERVER, to
365          * indicate wether the mode is a channel mode, a client mode, or a server mode.
366          * requires_oper is used with MT_CLIENT type modes only to indicate the mode can only
367          * be set or unset by an oper. If this is used for MT_CHANNEL type modes it is ignored.
368          * params_when_on is the number of modes to expect when the mode is turned on
369          * (for type MT_CHANNEL only), e.g. with mode +k, this would have a value of 1.
370          * the params_when_off value has a similar value to params_when_on, except it indicates
371          * the number of parameters to expect when the mode is disabled. Modes which act in a similar
372          * way to channel mode +l (e.g. require a parameter to enable, but not to disable) should
373          * use this parameter. The function returns false if the mode is unavailable, and will not
374          * attempt to allocate another character, as this will confuse users. This also means that
375          * as only one module can claim a specific mode character, the core does not need to keep track
376          * of which modules own which modes, which speeds up operation of the server. In this version,
377          * a mode can have at most one parameter, attempting to use more parameters will have undefined
378          * effects.
379          */
380         virtual bool AddExtendedMode(char modechar, int type, bool requires_oper, int params_when_on, int params_when_off);
381
382         /** Adds a command to the command table.
383          * This allows modules to add extra commands into the command table. You must place a function within your
384          * module which is is of type handlerfunc:
385          * 
386          * typedef void (handlerfunc) (char**, int, userrec*);
387          * ...
388          * void handle_kill(char **parameters, int pcnt, userrec *user)
389          *
390          * When the command is typed, the parameters will be placed into the parameters array (similar to argv) and
391          * the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters
392          * than the 'minparams' value you specified when creating the command. The *user parameter is the class of
393          * the user which caused the command to trigger, who will always have the flag you specified in 'flags' when
394          * creating the initial command. For example to create an oper only command create the commands with flags='o'.
395          */
396         virtual void AddCommand(char* cmd, handlerfunc f, char flags, int minparams);
397          
398         /** Sends a servermode.
399          * you must format the parameters array with the target, modes and parameters for those modes.
400          *
401          * For example:
402          *
403          * char *modes[3];
404          *
405          * modes[0] = ChannelName;
406          *
407          * modes[1] = "+o";
408          *
409          * modes[2] = user->nick;
410          *
411          * Srv->SendMode(modes,3,user);
412          *
413          * The modes will originate from the server where the command was issued, however responses (e.g. numerics)
414          * will be sent to the user you provide as the third parameter.
415          * You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave
416          * your server in an unstable state!
417          */
418
419         virtual void SendMode(char **parameters, int pcnt, userrec *user);
420         
421         /** Sends to all users matching a mode mask
422          * You must specify one or more usermodes as the first parameter. These can be RFC specified modes such as +i,
423          * or module provided modes, including ones provided by your own module.
424          * In the second parameter you must place a flag value which indicates wether the modes you have given will be
425          * logically ANDed or OR'ed. You may use one of either WM_AND or WM_OR.
426          * for example, if you were to use:
427          *
428          * Serv->SendToModeMask("xi", WM_OR, "m00");
429          *
430          * Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the
431          * user must have both modes set to receive the message.
432          */
433         virtual void SendToModeMask(std::string modes, int flags, std::string text);
434
435         /** Forces a user to join a channel.
436          * This is similar to svsjoin and can be used to implement redirection, etc.
437          * On success, the return value is a valid pointer to a chanrec* of the channel the user was joined to.
438          * On failure, the result is NULL.
439          */
440         virtual chanrec* JoinUserToChannel(userrec* user, std::string cname, std::string key);
441         
442         /** Forces a user to part a channel.
443          * This is similar to svspart and can be used to implement redirection, etc.
444          * Although the return value of this function is a pointer to a channel record, the returned data is
445          * undefined and should not be read or written to. This behaviour may be changed in a future version.
446          */
447         virtual chanrec* PartUserFromChannel(userrec* user, std::string cname, std::string reason);
448         
449         /** Forces a user nickchange.
450          * This command works similarly to SVSNICK, and can be used to implement Q-lines etc.
451          * If you specify an invalid nickname, the nick change will be dropped and the target user will receive
452          * the error numeric for it.
453          */
454         virtual void ChangeUserNick(userrec* user, std::string nickname);
455         
456         /** Forces a user to quit with the specified reason.
457          * To the user, it will appear as if they typed /QUIT themselves, except for the fact that this function
458          * may bypass the quit prefix specified in the config file.
459          *
460          * WARNING!
461          *
462          * Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or
463          * read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of
464          * action after calling this method is to immediately bail from your handler.
465          */
466         virtual void QuitUser(userrec* user, std::string reason);
467         
468         /**  Matches text against a glob pattern.
469          * Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com
470          * Returns true if the literal successfully matches the pattern, false if otherwise.
471          */
472         virtual bool MatchText(std::string sliteral, std::string spattern);
473         
474         /** Calls the handler for a command, either implemented by the core or by another module.
475          * You can use this function to trigger other commands in the ircd, such as PRIVMSG, JOIN,
476          * KICK etc, or even as a method of callback. By defining command names that are untypeable
477          * for users on irc (e.g. those which contain a \r or \n) you may use them as callback identifiers.
478          * The first parameter to this method is the name of the command handler you wish to call, e.g.
479          * PRIVMSG. This will be a command handler previously registered by the core or wih AddCommand().
480          * The second parameter is an array of parameters, and the third parameter is a count of parameters
481          * in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the
482          * functiom will silently ignore it. The final parameter is the user executing the command handler,
483          * used for privilage checks, etc.
484          */
485         virtual void CallCommandHandler(std::string commandname, char** parameters, int pcnt, userrec* user);
486         
487         /** Change displayed hostname of a user.
488          * You should always call this method to change a user's host rather than writing directly to the
489          * dhost member of userrec, as any change applied via this method will be propogated to any
490          * linked servers.
491          */     
492         virtual void ChangeHost(userrec* user, std::string host);
493         
494         /** Change GECOS (fullname) of a user.
495          * You should always call this method to change a user's GECOS rather than writing directly to the
496          * fullname member of userrec, as any change applied via this method will be propogated to any
497          * linked servers.
498          */     
499         virtual void ChangeGECOS(userrec* user, std::string gecos);
500         
501         /** Returns true if the servername you give is ulined.
502          * ULined servers have extra privilages. They are allowed to change nicknames on remote servers,
503          * change modes of clients which are on remote servers and set modes of channels where there are
504          * no channel operators for that channel on the ulined server, amongst other things. Ulined server
505          * data is also broadcast across the mesh at all times as opposed to selectively messaged in the
506          * case of normal servers, as many ulined server types (such as services) do not support meshed
507          * links and must operate in this manner.
508          */
509         virtual bool IsUlined(std::string server);
510 };
511
512 /** Allows reading of values from configuration files
513  * This class allows a module to read from either the main configuration file (inspircd.conf) or from
514  * a module-specified configuration file. It may either be instantiated with one parameter or none.
515  * Constructing the class using one parameter allows you to specify a path to your own configuration
516  * file, otherwise, inspircd.conf is read.
517  */
518 class ConfigReader : public classbase
519 {
520   protected:
521         /** The contents of the configuration file
522          * This protected member should never be accessed by a module (and cannot be accessed unless the
523          * core is changed). It will contain a pointer to the configuration file data with unneeded data
524          * (such as comments) stripped from it.
525          */
526         std::stringstream *cache;
527         /** Used to store errors
528          */
529         bool error;
530         
531   public:
532         /** Default constructor.
533          * This constructor initialises the ConfigReader class to read the inspircd.conf file
534          * as specified when running ./configure.
535          */
536         ConfigReader();                 // default constructor reads ircd.conf
537         /** Overloaded constructor.
538          * This constructor initialises the ConfigReader class to read a user-specified config file
539          */
540         ConfigReader(std::string filename);     // read a module-specific config
541         /** Default destructor.
542          * This method destroys the ConfigReader class.
543          */
544         ~ConfigReader();
545         /** Retrieves a value from the config file.
546          * This method retrieves a value from the config file. Where multiple copies of the tag
547          * exist in the config file, index indicates which of the values to retrieve.
548          */
549         std::string ReadValue(std::string tag, std::string name, int index);
550         /** Counts the number of times a given tag appears in the config file.
551          * This method counts the number of times a tag appears in a config file, for use where
552          * there are several tags of the same kind, e.g. with opers and connect types. It can be
553          * used with the index value of ConfigReader::ReadValue to loop through all copies of a
554          * multiple instance tag.
555          */
556         int Enumerate(std::string tag);
557         /** Returns true if a config file is valid.
558          * This method is partially implemented and will only return false if the config
559          * file does not exist or could not be opened.
560          */
561         bool Verify();
562
563         /** Returns the number of items within a tag.
564          * For example if the tag was &lt;test tag="blah" data="foo"&gt; then this
565          * function would return 2. Spaces and newlines both qualify as valid seperators
566          * between values.
567          */
568         int EnumerateValues(std::string tag, int index);
569 };
570
571
572
573 /** Caches a text file into memory and can be used to retrieve lines from it.
574  * This class contains methods for read-only manipulation of a text file in memory.
575  * Either use the constructor type with one parameter to load a file into memory
576  * at construction, or use the LoadFile method to load a file.
577  */
578 class FileReader : public classbase
579 {
580  file_cache fc;
581  public:
582          /** Default constructor.
583           * This method does not load any file into memory, you must use the LoadFile method
584           * after constructing the class this way.
585           */
586          FileReader();
587
588          /** Secondary constructor.
589           * This method initialises the class with a file loaded into it ready for GetLine and
590           * and other methods to be called. If the file could not be loaded, FileReader::FileSize
591           * returns 0.
592           */
593          FileReader(std::string filename);
594
595          /** Default destructor.
596           * This deletes the memory allocated to the file.
597           */
598          ~FileReader();
599
600          /** Used to load a file.
601           * This method loads a file into the class ready for GetLine and
602           * and other methods to be called. If the file could not be loaded, FileReader::FileSize
603           * returns 0.
604           */
605          void LoadFile(std::string filename);
606
607          /** Returns true if the file exists
608           * This function will return false if the file could not be opened.
609           */
610          bool Exists();
611          
612          /** Retrieve one line from the file.
613           * This method retrieves one line from the text file. If an empty non-NULL string is returned,
614           * the index was out of bounds, or the line had no data on it.
615           */
616          std::string GetLine(int x);
617
618          /** Returns the size of the file in lines.
619           * This method returns the number of lines in the read file. If it is 0, no lines have been
620           * read into memory, either because the file is empty or it does not exist, or cannot be
621           * opened due to permission problems.
622           */
623          int FileSize();
624 };
625
626
627 /** Instantiates classes inherited from Module
628  * This class creates a class inherited from type Module, using new. This is to allow for modules
629  * to create many different variants of Module, dependent on architecture, configuration, etc.
630  * In most cases, the simple class shown in the example module m_foobar.so will suffice for most
631  * modules.
632  */
633 class ModuleFactory : public classbase
634 {
635  public:
636         ModuleFactory() { }
637         virtual ~ModuleFactory() { }
638         /** Creates a new module.
639          * Your inherited class of ModuleFactory must return a pointer to your Module class
640          * using this method.
641          */
642         virtual Module * CreateModule() = 0;
643 };
644
645
646 typedef DLLFactory<ModuleFactory> ircd_module;
647
648 #endif