- /** 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);
-
- /** 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(char **parameters, int pcnt, userrec *user);
-
- /** Sends to all users matching a mode mask
- * You must specify one or more usermodes as the first parameter. These can be RFC specified modes such as +i,
- * or module provided modes, including ones provided by your own module.
- * In the second parameter you must place a flag value which indicates wether the modes you have given will be
- * logically ANDed or OR'ed. You may use one of either WM_AND or WM_OR.
- * for example, if you were to use:
- *
- * Serv->SendToModeMask("xi", WM_OR, "m00");
- *
- * Then the text 'm00' will be sent to all users with EITHER mode x or i. Conversely if you used WM_AND, the
- * user must have both modes set to receive the message.
- */
- virtual void SendToModeMask(const std::string &modes, int flags, const std::string &text);
-
- /** Forces a user to join a channel.
- * This is similar to svsjoin and can be used to implement redirection, etc.
- * On success, the return value is a valid pointer to a chanrec* of the channel the user was joined to.
- * On failure, the result is NULL.
- */
- virtual chanrec* JoinUserToChannel(userrec* user, const std::string &cname, const std::string &key);
-
- /** Forces a user to part a channel.
- * This is similar to svspart and can be used to implement redirection, etc.
- * Although the return value of this function is a pointer to a channel record, the returned data is
- * undefined and should not be read or written to. This behaviour may be changed in a future version.
- */
- virtual chanrec* PartUserFromChannel(userrec* user, const std::string &cname, const std::string &reason);
-
- /** Forces a user nickchange.
- * This command works similarly to SVSNICK, and can be used to implement Q-lines etc.
- * If you specify an invalid nickname, the nick change will be dropped and the target user will receive
- * the error numeric for it.
- */
- virtual void ChangeUserNick(userrec* user, const std::string &nickname);
-
- /** Forces a user to quit with the specified reason.
- * To the user, it will appear as if they typed /QUIT themselves, except for the fact that this function
- * may bypass the quit prefix specified in the config file.
- *
- * WARNING!
- *
- * Once you call this function, userrec* user will immediately become INVALID. You MUST NOT write to, or
- * read from this pointer after calling the QuitUser method UNDER ANY CIRCUMSTANCES! The best course of
- * action after calling this method is to immediately bail from your handler.
- */
- virtual void QuitUser(userrec* user, const std::string &reason);
-
- /** Makes a user kick another user, with the specified reason.
- * If source is NULL, the server will peform the kick.
- * @param The person or server (if NULL) performing the KICK
- * @param target The person being kicked
- * @param chan The channel to kick from
- * @param reason The kick reason
- */
- virtual void KickUser(userrec* source, userrec* target, chanrec* chan, const std::string &reason);
-
- /** Matches text against a glob pattern.
- * Uses the ircd's internal matching function to match string against a globbing pattern, e.g. *!*@*.com
- * Returns true if the literal successfully matches the pattern, false if otherwise.
- */
- virtual bool MatchText(const std::string &sliteral, const std::string &spattern);
-
- /** Calls the handler for a command, either implemented by the core or by another module.
- * You can use this function to trigger other commands in the ircd, such as PRIVMSG, JOIN,
- * KICK etc, or even as a method of callback. By defining command names that are untypeable
- * for users on irc (e.g. those which contain a \r or \n) you may use them as callback identifiers.
- * The first parameter to this method is the name of the command handler you wish to call, e.g.
- * PRIVMSG. This will be a command handler previously registered by the core or wih AddCommand().
- * The second parameter is an array of parameters, and the third parameter is a count of parameters
- * in the array. If you do not pass enough parameters to meet the minimum needed by the handler, the
- * functiom will silently ignore it. The final parameter is the user executing the command handler,
- * used for privilage checks, etc.
- * @return True if the command exists
- */
- virtual bool CallCommandHandler(const std::string &commandname, char** parameters, int pcnt, userrec* user);
-
- /** This function returns true if the commandname exists, pcnt is equal to or greater than the number
- * of paramters the command requires, the user specified is allowed to execute the command, AND
- * if the command is implemented by a module (not the core). This has a few specific uses, usually
- * within network protocols (see src/modules/m_spanningtree.cpp)
- */
- virtual bool IsValidModuleCommand(const std::string &commandname, int pcnt, userrec* user);
-
- /** Change displayed hostname of a user.
- * You should always call this method to change a user's host rather than writing directly to the
- * dhost member of userrec, as any change applied via this method will be propogated to any
- * linked servers.
- */
- virtual void ChangeHost(userrec* user, const std::string &host);
-
- /** Change GECOS (fullname) of a user.
- * You should always call this method to change a user's GECOS rather than writing directly to the
- * fullname member of userrec, as any change applied via this method will be propogated to any
- * linked servers.
- */
- virtual void ChangeGECOS(userrec* user, const std::string &gecos);
-
- /** Returns true if the servername you give is ulined.
- * ULined servers have extra privilages. They are allowed to change nicknames on remote servers,
- * change modes of clients which are on remote servers and set modes of channels where there are
- * no channel operators for that channel on the ulined server, amongst other things.
- */
- virtual bool IsUlined(const std::string &server);
-
- /** Fetches the userlist of a channel. This function must be here and not a member of userrec or
- * chanrec due to include constraints.
- */
- virtual chanuserlist GetUsers(chanrec* chan);
-
- /** Remove a user's connection to the irc server, but leave their client in existence in the
- * user hash. When you call this function, the user's file descriptor will be replaced with the
- * value of FD_MAGIC_NUMBER and their old file descriptor will be closed. This idle client will
- * remain until it is restored with a valid file descriptor, or is removed from IRC by an operator
- * After this call, the pointer to user will be invalid.
- */
- virtual bool UserToPseudo(userrec* user, const std::string &message);
-
- /** This user takes one user, and switches their file descriptor with another user, so that one user
- * "becomes" the other. The user in 'alive' is booted off the server with the given message. The user
- * referred to by 'zombie' should have previously been locked with Server::UserToPseudo, otherwise
- * stale sockets and file descriptor leaks can occur. After this call, the pointer to alive will be
- * invalid, and the pointer to zombie will be equivalent in effect to the old pointer to alive.
- */
- virtual bool PseudoToUser(userrec* alive, userrec* zombie, const std::string &message);
-
- /** Adds a G-line
- * The G-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
- * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
- * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
- * to indicate who or what sent the data, usually this is the nickname of a person, or a server
- * name.
- */
- virtual void AddGLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
-
- /** Adds a Q-line
- * The Q-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
- * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
- * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
- * to indicate who or what sent the data, usually this is the nickname of a person, or a server
- * name.
- */
- virtual void AddQLine(long duration, const std::string &source, const std::string &reason, const std::string &nickname);
-
- /** Adds a Z-line
- * The Z-line is propogated to all of the servers in the mesh and enforced as soon as it is added.
- * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
- * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
- * to indicate who or what sent the data, usually this is the nickname of a person, or a server
- * name.
- */
- virtual void AddZLine(long duration, const std::string &source, const std::string &reason, const std::string &ipaddr);
-
- /** Adds a K-line
- * The K-line is enforced as soon as it is added.
- * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
- * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
- * to indicate who or what sent the data, usually this is the nickname of a person, or a server
- * name.
- */
- virtual void AddKLine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
-
- /** Adds a E-line
- * The E-line is enforced as soon as it is added.
- * The duration must be in seconds, however you can use the Server::CalcDuration method to convert
- * durations into the 1w2d3h3m6s format used by /GLINE etc. The source is an arbitary string used
- * to indicate who or what sent the data, usually this is the nickname of a person, or a server
- * name.
- */
- virtual void AddELine(long duration, const std::string &source, const std::string &reason, const std::string &hostmask);
-
- /** Deletes a G-Line from all servers
- */
- virtual bool DelGLine(const std::string &hostmask);
-
- /** Deletes a Q-Line from all servers
- */
- virtual bool DelQLine(const std::string &nickname);
-
- /** Deletes a Z-Line from all servers
- */
- virtual bool DelZLine(const std::string &ipaddr);
-
- /** Deletes a local K-Line
- */
- virtual bool DelKLine(const std::string &hostmask);
-
- /** Deletes a local E-Line
- */
- virtual bool DelELine(const std::string &hostmask);
-
- /** Calculates a duration
- * This method will take a string containing a formatted duration (e.g. "1w2d") and return its value
- * as a total number of seconds. This is the same function used internally by /GLINE etc to set
- * the ban times.
- */
- virtual long CalcDuration(const std::string &duration);
-
- /** Returns true if a nick!ident@host string is correctly formatted, false if otherwise.
- */
- virtual bool IsValidMask(const std::string &mask);
-
- /** This function finds a module by name.
- * You must provide the filename of the module. If the module cannot be found (is not loaded)
- * the function will return NULL.
- */
- virtual Module* FindModule(const std::string &name);
-
- /** Adds a class derived from InspSocket to the server's socket engine.
- */
- virtual void AddSocket(InspSocket* sock);
-
- /** Forcibly removes a class derived from InspSocket from the servers socket engine.
- */
- virtual void RemoveSocket(InspSocket* sock);
-
- /** Deletes a class derived from InspSocket from the server's socket engine.
- */
- virtual void DelSocket(InspSocket* sock);
-
- /** Causes the local server to rehash immediately.
- * WARNING: Do not call this method from within your rehash method, for
- * obvious reasons!
- */
- virtual void RehashServer();
-
- /** This method returns the total number of channels on the network.
- */
- virtual long GetChannelCount();
-
- /** This method returns a channel whos index is greater than or equal to 0 and less than the number returned by Server::GetChannelCount().
- * This is slower (by factors of dozens) than requesting a channel by name with Server::FindChannel(), however there are times when
- * you wish to safely iterate the channel list, saving your position, with large amounts of time in between, which is what this function
- * is useful for.
- */
- virtual chanrec* GetChannelIndex(long index);
-
- /** Dumps text (in a stringstream) to a user. The stringstream should not contain linefeeds, as it will be split
- * automatically by the function into safe amounts. The line prefix given is prepended onto each line (e.g. a servername
- * and a numeric).
- */
- void DumpText(userrec* User, const std::string &LinePrefix, stringstream &TextStream);