-};
-
-
-/** Allows server output and query functions
- * This class contains methods which allow a module to query the state of the irc server, and produce
- * output to users and other servers. All modules should instantiate at least one copy of this class,
- * and use its member functions to perform their tasks.
- */
-class Server : public Extensible
-{
- public:
- /** Default constructor.
- * Creates a Server object.
- */
- Server();
-
- /** Default destructor.
- * Destroys a Server object.
- */
- virtual ~Server();
-
- /** Obtains a pointer to the server's ServerConfig object.
- * The ServerConfig object contains most of the configuration data
- * of the IRC server, as read from the config file by the core.
- */
- ServerConfig* GetConfig();
-
- /** For use with Module::Prioritize().
- * When the return value of this function is returned from
- * Module::Prioritize(), this specifies that the module wishes
- * to be ordered exactly BEFORE 'modulename'. For more information
- * please see Module::Prioritize().
- * @param modulename The module your module wants to be before in the call list
- * @returns a priority ID which the core uses to relocate the module in the list
- */
- long PriorityBefore(const std::string &modulename);
-
- /** For use with Module::Prioritize().
- * When the return value of this function is returned from
- * Module::Prioritize(), this specifies that the module wishes
- * to be ordered exactly AFTER 'modulename'. For more information please
- * see Module::Prioritize().
- * @param modulename The module your module wants to be after in the call list
- * @returns a priority ID which the core uses to relocate the module in the list
- */
- long PriorityAfter(const std::string &modulename);
-
- /** Sends text to all opers.
- * This method sends a server notice to all opers with the usermode +s.
- */
- virtual void SendOpers(const std::string &s);
-
- /** Returns the version string of this server
- */
- std::string GetVersion();
-
- /** Publish a 'feature'.
- * There are two ways for a module to find another module it depends on.
- * Either by name, using Server::FindModule, or by feature, using this
- * function. A feature is an arbitary string which identifies something this
- * module can do. For example, if your module provides SSL support, but other
- * modules provide SSL support too, all the modules supporting SSL should
- * publish an identical 'SSL' feature. This way, any module requiring use
- * of SSL functions can just look up the 'SSL' feature using FindFeature,
- * then use the module pointer they are given.
- * @param FeatureName The case sensitive feature name to make available
- * @param Mod a pointer to your module class
- * @returns True on success, false if the feature is already published by
- * another module.
- */
- bool PublishFeature(const std::string &FeatureName, Module* Mod);
-
- /** Unpublish a 'feature'.
- * When your module exits, it must call this method for every feature it
- * is providing so that the feature table is cleaned up.
- * @param FeatureName the feature to remove
- */
- bool UnpublishFeature(const std::string &FeatureName);
-
- /** Find a 'feature'.
- * There are two ways for a module to find another module it depends on.
- * Either by name, using Server::FindModule, or by feature, using the
- * Server::PublishFeature method. A feature is an arbitary string which
- * identifies something this module can do. For example, if your module
- * provides SSL support, but other modules provide SSL support too, all
- * the modules supporting SSL should publish an identical 'SSL' feature.
- * To find a module capable of providing the feature you want, simply
- * call this method with the feature name you are looking for.
- * @param FeatureName The feature name you wish to obtain the module for
- * @returns A pointer to a valid module class on success, NULL on failure.
- */
- Module* FindFeature(const std::string &FeatureName);
-
- const std::string& GetModuleName(Module* m);
-
- /** Writes a log string.
- * This method writes a line of text to the log. If the level given is lower than the
- * level given in the configuration, this command has no effect.
- */
- virtual void Log(int level, const std::string &s);
-
- /** Returns true if a nick is valid.
- * Nicks for unregistered connections will return false.
- */
- virtual bool IsNick(const std::string &nick);
-
- /** Adds an InspTimer which will trigger at a future time
- */
- virtual void AddTimer(InspTimer* T);
-
- /** Attempts to look up a nick and return a pointer to it.
- * This function will return NULL if the nick does not exist.
- */
- virtual userrec* FindNick(const std::string &nick);
-
- /** Attempts to look up a nick using the file descriptor associated with that nick.
- * This function will return NULL if the file descriptor is not associated with a valid user.
- */
- virtual userrec* FindDescriptor(int socket);
-
- /** Attempts to look up a channel and return a pointer to it.
- * This function will return NULL if the channel does not exist.
- */
- virtual chanrec* FindChannel(const std::string &channel);
-
- /** Attempts to look up a user's privilages on a channel.
- * This function will return a string containing either @, %, +, or an empty string,
- * representing the user's privilages upon the channel you specify.
- */
- virtual std::string ChanMode(userrec* User, chanrec* Chan);
-
- /** Returns the server name of the server where the module is loaded.
- */
- virtual std::string GetServerName();
-
- /** Returns the network name, global to all linked servers.
- */
- virtual std::string GetNetworkName();
-
- /** Returns the server description string of the local server
- */
- virtual std::string GetServerDescription();
-
- /** Returns the information of the server as returned by the /ADMIN command.
- * See the Admin class for further information of the return value. The members
- * Admin::Nick, Admin::Email and Admin::Name contain the information for the
- * server where the module is loaded.
- */
- virtual Admin GetAdmin();
-
- virtual bool AddMode(ModeHandler* mh, const unsigned char modechar);
-
- virtual bool AddModeWatcher(ModeWatcher* mw);
-
- virtual bool DelModeWatcher(ModeWatcher* mw);
-
- virtual bool AddResolver(Resolver* r);
-
- /** Adds a command to the command table.
- * This allows modules to add extra commands into the command table. You must place a function within your
- * module which is is of type handlerfunc:
- *
- * typedef void (handlerfunc) (char**, int, userrec*);
- * ...
- * void handle_kill(char **parameters, int pcnt, userrec *user)
- *
- * When the command is typed, the parameters will be placed into the parameters array (similar to argv) and
- * the parameter count will be placed into pcnt (similar to argv). There will never be any less parameters
- * than the 'minparams' value you specified when creating the command. The *user parameter is the class of
- * the user which caused the command to trigger, who will always have the flag you specified in 'flags' when
- * creating the initial command. For example to create an oper only command create the commands with flags='o'.
- * The source parameter is used for resource tracking, and should contain the name of your module (with file
- * extension) e.g. "m_blarp.so". If you place the wrong identifier here, you can cause crashes if your module
- * is unloaded.
- */
- virtual void AddCommand(command_t *f);
-
- /** Sends a servermode.
- * you must format the parameters array with the target, modes and parameters for those modes.
- *
- * For example:
- *
- * char *modes[3];
- *
- * modes[0] = ChannelName;
- *
- * modes[1] = "+o";
- *
- * modes[2] = user->nick;
- *
- * Srv->SendMode(modes,3,user);
- *
- * The modes will originate from the server where the command was issued, however responses (e.g. numerics)
- * will be sent to the user you provide as the third parameter.
- * You must be sure to get the number of parameters correct in the pcnt parameter otherwise you could leave
- * your server in an unstable state!
- */
-
- virtual void SendMode(const char **parameters, int pcnt, userrec *user);