Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

home » brain » inspircd-cvs » inspircd » src

modules.cpp

Go to the documentation of this file.

/*       +------------------------------------+
 *       | Inspire Internet Relay Chat Daemon |
 *       +------------------------------------+
 *
 *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
 * See: http://www.inspircd.org/wiki/index.php/Credits
 *
 * This program is free but copyrighted software; see
 *            the file COPYING for details.
 *
 * ---------------------------------------------------
 */

/* $Core */

#include "inspircd.h"
#include "xline.h"
#include "socket.h"
#include "socketengine.h"
#include "command_parse.h"
#include "dns.h"
#include "exitcodes.h"

#ifndef WIN32
        #include <dirent.h>
#endif

// version is a simple class for holding a modules version number
Version::Version(const std::string &sversion, int flags, int api_ver)
: version(sversion), Flags(flags), API(api_ver)
{
}

Request::Request(char* anydata, Module* src, Module* dst)
: data(anydata), source(src), dest(dst)
{
        /* Ensure that because this module doesnt support ID strings, it doesnt break modules that do
         * by passing them uninitialized pointers (could happen)
         */
        id = '\0';
}

Request::Request(Module* src, Module* dst, const char* idstr)
: id(idstr), source(src), dest(dst)
{
}

char* Request::GetData()
{
        return this->data;
}

const char* Request::GetId()
{
        return this->id;
}

Module* Request::GetSource()
{
        return this->source;
}

Module* Request::GetDest()
{
        return this->dest;
}

const char* Request::Send()
{
        if (this->dest)
        {
                return dest->OnRequest(this);
        }
        else
        {
                return NULL;
        }
}

Event::Event(char* anydata, Module* src, const std::string &eventid) : data(anydata), source(src), id(eventid) { }

char* Event::GetData()
{
        return (char*)this->data;
}

Module* Event::GetSource()
{
        return this->source;
}

char* Event::Send(InspIRCd* ServerInstance)
{
        FOREACH_MOD(I_OnEvent,OnEvent(this));
        return NULL;
}

std::string Event::GetEventID()
{
        return this->id;
}


// These declarations define the behavours of the base class Module (which does nothing at all)

Module::Module(InspIRCd* Me) : ServerInstance(Me) { }
Module::~Module() { }

int             Module::OnSendSnotice(char &snomask, std::string &type, const std::string &message) { return 0; }
void            Module::OnUserConnect(User*) { }
void            Module::OnUserQuit(User*, const std::string&, const std::string&) { }
void            Module::OnUserDisconnect(User*) { }
void            Module::OnUserJoin(User*, Channel*, bool, bool&) { }
void            Module::OnPostJoin(User*, Channel*) { }
void            Module::OnUserPart(User*, Channel*, std::string&, bool&) { }
void            Module::OnRehash(User*, const std::string&) { }
void            Module::OnServerRaw(std::string&, bool, User*) { }
int             Module::OnUserPreJoin(User*, Channel*, const char*, std::string&, const std::string&) { return 0; }
void            Module::OnMode(User*, void*, int, const std::string&) { }
Version         Module::GetVersion() { return Version("Misconfigured", VF_VENDOR, -1); }
void            Module::OnOper(User*, const std::string&) { }
void            Module::OnPostOper(User*, const std::string&, const std::string &) { }
void            Module::OnInfo(User*) { }
void            Module::OnWhois(User*, User*) { }
int             Module::OnUserPreInvite(User*, User*, Channel*, time_t) { return 0; }
int             Module::OnUserPreMessage(User*, void*, int, std::string&, char, CUList&) { return 0; }
int             Module::OnUserPreNotice(User*, void*, int, std::string&, char, CUList&) { return 0; }
int             Module::OnUserPreNick(User*, const std::string&) { return 0; }
void            Module::OnUserPostNick(User*, const std::string&) { }
int             Module::OnAccessCheck(User*, User*, Channel*, int) { return ACR_DEFAULT; }
void            Module::On005Numeric(std::string&) { }
int             Module::OnKill(User*, User*, const std::string&) { return 0; }
void            Module::OnLoadModule(Module*, const std::string&) { }
void            Module::OnUnloadModule(Module*, const std::string&) { }
void            Module::OnBackgroundTimer(time_t) { }
int             Module::OnPreCommand(std::string&, std::vector<std::string>&, User *, bool, const std::string&) { return 0; }
void            Module::OnPostCommand(const std::string&, const std::vector<std::string>&, User *, CmdResult, const std::string&) { }
bool            Module::OnCheckReady(User*) { return true; }
int             Module::OnUserRegister(User*) { return 0; }
int             Module::OnUserPreKick(User*, User*, Channel*, const std::string&) { return 0; }
void            Module::OnUserKick(User*, User*, Channel*, const std::string&, bool&) { }
int             Module::OnRawMode(User*, Channel*, const char, const std::string &, bool, int, bool) { return 0; }
int             Module::OnCheckInvite(User*, Channel*) { return 0; }
int             Module::OnCheckKey(User*, Channel*, const std::string&) { return 0; }
int             Module::OnCheckLimit(User*, Channel*) { return 0; }
int             Module::OnCheckBan(User*, Channel*) { return 0; }
int             Module::OnCheckExtBan(User *, Channel *, char) { return 0; }
int             Module::OnCheckStringExtBan(const std::string &s, Channel *c, char type) { return 0; }
int             Module::OnStats(char, User*, string_list&) { return 0; }
int             Module::OnChangeLocalUserHost(User*, const std::string&) { return 0; }
int             Module::OnChangeLocalUserGECOS(User*, const std::string&) { return 0; }
int             Module::OnLocalTopicChange(User*, Channel*, const std::string&) { return 0; }
void            Module::OnEvent(Event*) { return; }
const char*             Module::OnRequest(Request*) { return NULL; }
int             Module::OnPassCompare(Extensible* ex, const std::string &password, const std::string &input, const std::string& hashtype) { return 0; }
void            Module::OnGlobalOper(User*) { }
void            Module::OnPostConnect(User*) { }
int             Module::OnAddBan(User*, Channel*, const std::string &) { return 0; }
int             Module::OnDelBan(User*, Channel*, const std::string &) { return 0; }
void            Module::OnRawSocketAccept(int, const std::string&, int) { }
int             Module::OnRawSocketWrite(int, const char*, int) { return 0; }
void            Module::OnRawSocketClose(int) { }
void            Module::OnRawSocketConnect(int) { }
int             Module::OnRawSocketRead(int, char*, unsigned int, int&) { return 0; }
void            Module::OnUserMessage(User*, void*, int, const std::string&, char, const CUList&) { }
void            Module::OnUserNotice(User*, void*, int, const std::string&, char, const CUList&) { }
void            Module::OnRemoteKill(User*, User*, const std::string&, const std::string&) { }
void            Module::OnUserInvite(User*, User*, Channel*, time_t) { }
void            Module::OnPostLocalTopicChange(User*, Channel*, const std::string&) { }
void            Module::OnGetServerDescription(const std::string&, std::string&) { }
void            Module::OnSyncUser(User*, Module*, void*) { }
void            Module::OnSyncChannel(Channel*, Module*, void*) { }
void            Module::ProtoSendMode(void*, int, void*, const std::string&) { }
void            Module::OnSyncChannelMetaData(Channel*, Module*, void*, const std::string&, bool) { }
void            Module::OnSyncUserMetaData(User*, Module*, void*, const std::string&, bool) { }
void            Module::OnSyncOtherMetaData(Module*, void*, bool) { }
void            Module::OnDecodeMetaData(int, void*, const std::string&, const std::string&) { }
void            Module::ProtoSendMetaData(void*, int, void*, const std::string&, const std::string&) { }
void            Module::OnWallops(User*, const std::string&) { }
void            Module::OnChangeHost(User*, const std::string&) { }
void            Module::OnChangeName(User*, const std::string&) { }
void            Module::OnAddLine(User*, XLine*) { }
void            Module::OnDelLine(User*, XLine*) { }
void            Module::OnExpireLine(XLine*) { }
void            Module::OnCleanup(int, void*) { }
int             Module::OnChannelPreDelete(Channel*) { return 0; }
void            Module::OnChannelDelete(Channel*) { }
int             Module::OnSetAway(User*, const std::string &) { return 0; }
int             Module::OnUserList(User*, Channel*, CUList*&) { return 0; }
int             Module::OnWhoisLine(User*, User*, int&, std::string&) { return 0; }
void            Module::OnBuildExemptList(MessageType, Channel*, User*, char, CUList&, const std::string&) { }
void            Module::OnGarbageCollect() { }
void            Module::OnBufferFlushed(User*) { }
void            Module::OnText(User*, void*, int, const std::string&, char, CUList&) { }
void            Module::OnRunTestSuite() { }
void            Module::OnNamesListItem(User*, User*, Channel*, std::string&, std::string&) { }
int             Module::OnNumeric(User*, unsigned int, const std::string&) { return 0; }
void            Module::OnHookUserIO(User*, const std::string&) { }
bool            Module::OnHostCycle(User* user) { return false; }

ModuleManager::ModuleManager(InspIRCd* Ins) : ModCount(0), Instance(Ins)
{
}

ModuleManager::~ModuleManager()
{
}

bool ModuleManager::Attach(Implementation i, Module* mod)
{
        if (std::find(EventHandlers[i].begin(), EventHandlers[i].end(), mod) != EventHandlers[i].end())
                return false;

        EventHandlers[i].push_back(mod);
        return true;
}

bool ModuleManager::Detach(Implementation i, Module* mod)
{
        EventHandlerIter x = std::find(EventHandlers[i].begin(), EventHandlers[i].end(), mod);

        if (x == EventHandlers[i].end())
                return false;

        EventHandlers[i].erase(x);
        return true;
}

void ModuleManager::Attach(Implementation* i, Module* mod, size_t sz)
{
        for (size_t n = 0; n < sz; ++n)
                Attach(i[n], mod);
}

void ModuleManager::DetachAll(Module* mod)
{
        for (size_t n = I_BEGIN + 1; n != I_END; ++n)
                Detach((Implementation)n, mod);
}

bool ModuleManager::SetPriority(Module* mod, PriorityState s)
{
        for (size_t n = I_BEGIN + 1; n != I_END; ++n)
                SetPriority(mod, (Implementation)n, s);

        return true;
}

bool ModuleManager::SetPriority(Module* mod, Implementation i, PriorityState s, Module** modules, size_t sz)
{
        size_t swap_pos = 0;
        size_t source = 0;
        bool swap = true;
        bool found = false;

        /* Locate our module. This is O(n) but it only occurs on module load so we're
         * not too bothered about it
         */
        for (size_t x = 0; x != EventHandlers[i].size(); ++x)
        {
                if (EventHandlers[i][x] == mod)
                {
                        source = x;
                        found = true;
                        break;
                }
        }

        /* Eh? this module doesnt exist, probably trying to set priority on an event
         * theyre not attached to.
         */
        if (!found)
                return false;

        switch (s)
        {
                /* Dummy value */
                case PRIO_DONTCARE:
                        swap = false;
                break;
                /* Module wants to be first, sod everything else */
                case PRIO_FIRST:
                        swap_pos = 0;
                break;
                /* Module is submissive and wants to be last... awww. */
                case PRIO_LAST:
                        if (EventHandlers[i].empty())
                                swap_pos = 0;
                        else
                                swap_pos = EventHandlers[i].size() - 1;
                break;
                /* Place this module after a set of other modules */
                case PRIO_AFTER:
                {
                        /* Find the latest possible position */
                        swap_pos = 0;
                        swap = false;
                        for (size_t x = 0; x != EventHandlers[i].size(); ++x)
                        {
                                for (size_t n = 0; n < sz; ++n)
                                {
                                        if ((modules[n]) && (EventHandlers[i][x] == modules[n]) && (x >= swap_pos) && (source <= swap_pos))
                                        {
                                                swap_pos = x;
                                                swap = true;
                                        }
                                }
                        }
                }
                break;
                /* Place this module before a set of other modules */
                case PRIO_BEFORE:
                {
                        swap_pos = EventHandlers[i].size() - 1;
                        swap = false;
                        for (size_t x = 0; x != EventHandlers[i].size(); ++x)
                        {
                                for (size_t n = 0; n < sz; ++n)
                                {
                                        if ((modules[n]) && (EventHandlers[i][x] == modules[n]) && (x <= swap_pos) && (source >= swap_pos))
                                        {
                                                swap = true;
                                                swap_pos = x;
                                        }
                                }
                        }
                }
                break;
        }

        /* Do we need to swap? */
        if (swap && (swap_pos != source))
        {
                /* Suggestion from Phoenix, "shuffle" the modules to better retain call order */
                int incrmnt = 1;

                if (source > swap_pos)
                        incrmnt = -1;

                for (unsigned int j = source; j != swap_pos; j += incrmnt)
                {
                        if (( j + incrmnt > EventHandlers[i].size() - 1) || (j + incrmnt < 0))
                                continue;

                        std::swap(EventHandlers[i][j], EventHandlers[i][j+incrmnt]);
                }
        }

        return true;
}

std::string& ModuleManager::LastError()
{
        return LastModuleError;
}

bool ModuleManager::Load(const char* filename)
{
        /* Do we have a glob pattern in the filename?
         * The user wants to load multiple modules which
         * match the pattern.
         */
        if (strchr(filename,'*') || (strchr(filename,'?')))
        {
                int n_match = 0;
                DIR* library = opendir(Instance->Config->ModPath);
                if (library)
                {
                        /* Try and locate and load all modules matching the pattern */
                        dirent* entry = NULL;
                        while (0 != (entry = readdir(library)))
                        {
                                if (InspIRCd::Match(entry->d_name, filename, NULL))
                                {
                                        if (!this->Load(entry->d_name))
                                                n_match++;
                                }
                        }
                        closedir(library);
                }
                /* Loadmodule will now return false if any one of the modules failed
                 * to load (but wont abort when it encounters a bad one) and when 1 or
                 * more modules were actually loaded.
                 */
                return (n_match > 0);
        }

        char modfile[MAXBUF];
        snprintf(modfile,MAXBUF,"%s/%s",Instance->Config->ModPath,filename);
        std::string filename_str = filename;

        if (!ServerConfig::DirValid(modfile))
        {
                LastModuleError = "Module " + std::string(filename) + " is not in the module directory that i am configured to look in (is "+Instance->Config->ModPath+" really a symlink?)";
                Instance->Logs->Log("MODULE", DEFAULT, LastModuleError);
                return false;
        }
        
        if (!ServerConfig::FileExists(modfile))
        {
                LastModuleError = "Module file could not be found: " + filename_str;
                Instance->Logs->Log("MODULE", DEFAULT, LastModuleError);
                return false;
        }
        
        if (Modules.find(filename_str) != Modules.end())
        {       
                LastModuleError = "Module " + filename_str + " is already loaded, cannot load a module twice!";
                Instance->Logs->Log("MODULE", DEFAULT, LastModuleError);
                return false;
        }
                
        Module* newmod = NULL;
        ircd_module* newhandle = NULL;

        try
        {
                /* This will throw a CoreException if there's a problem loading
                 * the module file or getting a pointer to the init_module symbol.
                 */
                newhandle = new ircd_module(Instance, modfile, "init_module");
                newmod = newhandle->CallInit();

                if (newmod)
                {
                        Version v = newmod->GetVersion();

                        if (v.API != API_VERSION)
                        {
                                DetachAll(newmod);
                                delete newmod;
                                delete newhandle;
                                LastModuleError = "Unable to load " + filename_str + ": Incorrect module API version: " + ConvToStr(v.API) + " (our version: " + ConvToStr(API_VERSION) + ")";
                                Instance->Logs->Log("MODULE", DEFAULT, LastModuleError);
                                return false;
                        }
                        else
                        {
                                Instance->Logs->Log("MODULE", DEFAULT,"New module introduced: %s (API version %d, Module version %s)%s", filename, v.API, v.version.c_str(), (!(v.Flags & VF_VENDOR) ? " [3rd Party]" : " [Vendor]"));
                        }

                        Modules[filename_str] = std::make_pair(newhandle, newmod);
                }
                else
                {
                        delete newhandle;
                        LastModuleError = "Unable to load " + filename_str + ": Probably missing init_module() entrypoint, but dlsym() didn't notice a problem";
                        Instance->Logs->Log("MODULE", DEFAULT, LastModuleError);
                        return false;
                }
        }
        catch (LoadModuleException& modexcept)
        {
                DetachAll(newmod);
                if (newmod)
                        delete newmod;
                if (newhandle)
                        delete newhandle;
                LastModuleError = "Unable to load " + filename_str + ": Error when loading: " + modexcept.GetReason();
                Instance->Logs->Log("MODULE", DEFAULT, LastModuleError);
                return false;
        }
        catch (FindSymbolException& modexcept)
        {
                DetachAll(newmod);
                if (newmod)
                        delete newmod;
                if (newhandle)
                        delete newhandle;
                LastModuleError = "Unable to load " + filename_str + ": Error finding symbol: " + modexcept.GetReason();
                Instance->Logs->Log("MODULE", DEFAULT, LastModuleError);
                return false;
        }
        catch (CoreException& modexcept)
        {
                DetachAll(newmod);
                if (newmod)
                        delete newmod;
                if (newhandle)
                        delete newhandle;
                LastModuleError = "Unable to load " + filename_str + ": " + modexcept.GetReason();
                Instance->Logs->Log("MODULE", DEFAULT, LastModuleError);
                return false;
        }

        this->ModCount++;
        FOREACH_MOD_I(Instance,I_OnLoadModule,OnLoadModule(newmod, filename_str));

        /* We give every module a chance to re-prioritize when we introduce a new one,
         * not just the one thats loading, as the new module could affect the preference
         * of others
         */
        for (std::map<std::string, std::pair<ircd_module*, Module*> >::iterator n = Modules.begin(); n != Modules.end(); ++n)
                n->second.second->Prioritize();

        Instance->BuildISupport();
        return true;
}

bool ModuleManager::Unload(const char* filename)
{
        std::string filename_str(filename);
        std::map<std::string, std::pair<ircd_module*, Module*> >::iterator modfind = Modules.find(filename);

        if (modfind != Modules.end())
        {
                if (modfind->second.second->GetVersion().Flags & VF_STATIC)
                {
                        LastModuleError = "Module " + filename_str + " not unloadable (marked static)";
                        Instance->Logs->Log("MODULE", DEFAULT, LastModuleError);
                        return false;
                }
                std::pair<int,std::string> intercount = GetInterfaceInstanceCount(modfind->second.second);
                if (intercount.first > 0)
                {
                        LastModuleError = "Failed to unload module " + filename_str + ", being used by " + ConvToStr(intercount.first) + " other(s) via interface '" + intercount.second + "'";
                        Instance->Logs->Log("MODULE", DEFAULT, LastModuleError);
                        return false;
                }

                /* Give the module a chance to tidy out all its metadata */
                for (chan_hash::iterator c = Instance->chanlist->begin(); c != Instance->chanlist->end(); c++)
                {
                        modfind->second.second->OnCleanup(TYPE_CHANNEL,c->second);
                }
                for (user_hash::iterator u = Instance->Users->clientlist->begin(); u != Instance->Users->clientlist->end(); u++)
                {
                        modfind->second.second->OnCleanup(TYPE_USER,u->second);
                }

                /* Tidy up any dangling resolvers */
                Instance->Res->CleanResolvers(modfind->second.second);


                FOREACH_MOD_I(Instance,I_OnUnloadModule,OnUnloadModule(modfind->second.second, modfind->first));

                this->DetachAll(modfind->second.second);

                Instance->Parser->RemoveCommands(filename);

                delete modfind->second.second;
                delete modfind->second.first;
                Modules.erase(modfind);

                Instance->Logs->Log("MODULE", DEFAULT,"Module %s unloaded",filename);
                this->ModCount--;
                Instance->BuildISupport();
                return true;
        }

        LastModuleError = "Module " + filename_str + " is not loaded, cannot unload it!";
        Instance->Logs->Log("MODULE", DEFAULT, LastModuleError);
        return false;
}

/* We must load the modules AFTER initializing the socket engine, now */
void ModuleManager::LoadAll()
{
        char configToken[MAXBUF];
        ModCount = -1;

        for(int count = 0; count < Instance->Config->ConfValueEnum(Instance->Config->config_data, "module"); count++)
        {
                Instance->Config->ConfValue(Instance->Config->config_data, "module", "name", count, configToken, MAXBUF);
                printf_c("[\033[1;32m*\033[0m] Loading module:\t\033[1;32m%s\033[0m\n",configToken);
                
                if (!this->Load(configToken))           
                {
                        Instance->Logs->Log("MODULE", DEFAULT, this->LastError());
                        printf_c("\n[\033[1;31m*\033[0m] %s\n\n", this->LastError().c_str());
                        Instance->Exit(EXIT_STATUS_MODULE);
                }
        }
}

bool ModuleManager::PublishFeature(const std::string &FeatureName, Module* Mod)
{
        if (Features.find(FeatureName) == Features.end())
        {
                Features[FeatureName] = Mod;
                return true;
        }
        return false;
}

bool ModuleManager::UnpublishFeature(const std::string &FeatureName)
{
        featurelist::iterator iter = Features.find(FeatureName);
        
        if (iter == Features.end())
                return false;

        Features.erase(iter);
        return true;
}

Module* ModuleManager::FindFeature(const std::string &FeatureName)
{
        featurelist::iterator iter = Features.find(FeatureName);

        if (iter == Features.end())
                return NULL;

        return iter->second;
}

bool ModuleManager::PublishInterface(const std::string &InterfaceName, Module* Mod)
{
        interfacelist::iterator iter = Interfaces.find(InterfaceName);

        if (iter == Interfaces.end())
        {
                modulelist ml;
                ml.push_back(Mod);
                Interfaces[InterfaceName] = std::make_pair(0, ml);
        }
        else
        {
                iter->second.second.push_back(Mod);
        }
        return true;
}

bool ModuleManager::UnpublishInterface(const std::string &InterfaceName, Module* Mod)
{
        interfacelist::iterator iter = Interfaces.find(InterfaceName);

        if (iter == Interfaces.end())
                return false;

        for (modulelist::iterator x = iter->second.second.begin(); x != iter->second.second.end(); x++)
        {
                if (*x == Mod)
                {
                        iter->second.second.erase(x);
                        if (iter->second.second.empty())
                                Interfaces.erase(InterfaceName);
                        return true;
                }
        }
        return false;
}

modulelist* ModuleManager::FindInterface(const std::string &InterfaceName)
{
        interfacelist::iterator iter = Interfaces.find(InterfaceName);
        if (iter == Interfaces.end())
                return NULL;
        else
                return &(iter->second.second);
}

bool ModuleManager::ModuleHasInterface(Module* mod, const std::string& InterfaceName)
{
        interfacelist::iterator iter = Interfaces.find(InterfaceName);
        if (iter == Interfaces.end())
                return false;
        else
        {
                modulelist& ml = iter->second.second;
                modulelist::iterator mi = std::find(ml.begin(), ml.end(), mod);
                return (mi != ml.end());
        }
}

void ModuleManager::UseInterface(const std::string &InterfaceName)
{
        interfacelist::iterator iter = Interfaces.find(InterfaceName);
        if (iter != Interfaces.end())
                iter->second.first++;

}

void ModuleManager::DoneWithInterface(const std::string &InterfaceName)
{
        interfacelist::iterator iter = Interfaces.find(InterfaceName);
        if (iter != Interfaces.end())
                iter->second.first--;
}

std::pair<int,std::string> ModuleManager::GetInterfaceInstanceCount(Module* m)
{
        for (interfacelist::iterator iter = Interfaces.begin(); iter != Interfaces.end(); iter++)
        {
                for (modulelist::iterator x = iter->second.second.begin(); x != iter->second.second.end(); x++)
                {
                        if (*x == m)
                        {
                                return std::make_pair(iter->