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

m_foobar.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.
 *
 * ---------------------------------------------------
 */

#include "inspircd.h"

/* $ModDesc: A dummy module for testing */

// Class ModuleFoobar inherits from Module
// It just outputs simple debug strings to show its methods are working.

class ModuleFoobar : public Module
{
 private:

         // It is recommended that your class makes use of one or more Server
         // objects. A server object is a class which contains methods which
         // encapsulate the exports from the core of the ircd.
         // such methods include Debug, SendChannel, etc.


 public:
        ModuleFoobar(InspIRCd* Me)
                : Module(Me)
        {
                // The constructor just makes a copy of the server class


                Implementation eventlist[] = { I_OnUserConnect, I_OnUserQuit, I_OnUserJoin, I_OnUserPart, I_OnUserPreJoin };
                ServerInstance->Modules->Attach(eventlist, this, 5);
        }

        virtual ~ModuleFoobar()
        {
        }

        virtual Version GetVersion()
        {
                // this method instantiates a class of type Version, and returns
                // the modules version information using it.

                return Version("$Id: m_foobar.cpp 10291 2008-08-25 20:35:51Z w00t $", VF_VENDOR, API_VERSION);
        }


        virtual void OnUserConnect(User* user)
        {
                // method called when a user connects

                std::string b = user->nick;
                ServerInstance->Logs->Log("m_foobar",DEBUG,"Foobar: User connecting: "+b);
        }

        virtual void OnUserQuit(User* user, const std::string &reason, const std::string &oper_message)
        {
                // method called when a user disconnects

                std::string b = user->nick;
                ServerInstance->Logs->Log("m_foobar",DEBUG,"Foobar: User quitting: "+b);
        }

        virtual void OnUserJoin(User* user, Channel* channel, bool sync, bool &silent)
        {
                // method called when a user joins a channel

                std::string c = channel->name;
                std::string b = user->nick;
                ServerInstance->Logs->Log("m_foobar",DEBUG,"Foobar: User "+b+" joined "+c);
        }

        virtual void OnUserPart(User* user, Channel* channel, std::string &partreason, bool &silent)
        {
                // method called when a user parts a channel

                std::string c = channel->name;
                std::string b = user->nick;
                ServerInstance->Logs->Log("m_foobar",DEBUG,"Foobar: User "+b+" parted "+c);
        }

        virtual int OnUserPreJoin(User* user, Channel* chan, const char* cname, std::string &privs, const std::string &keygiven)
        {
                return 0;
        }
};


MODULE_INIT(ModuleFoobar)