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

home » brain » inspircd-cvs » inspircd » include

u_listmode.h

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

#ifndef INSPIRCD_LISTMODE_PROVIDER
#define INSPIRCD_LISTMODE_PROVIDER

inline std::string stringtime()
{
        std::ostringstream TIME;
        TIME << time(NULL); 
        return TIME.str();
}

class ListItem : public classbase
{
public:
        std::string nick;
        std::string mask;
        std::string time;
};

class ListLimit : public classbase
{
public:
        std::string mask;
        unsigned int limit;
};

typedef std::vector<ListItem> modelist;
typedef std::vector<ListLimit> limitlist;

class ListModeRequest : public Request
{
 public:
        User* user;
        Channel* chan;

        ListModeRequest(Module* sender, Module* target, User* u, Channel* c) : Request(sender, target, "LM_CHECKLIST"), user(u), chan(c)
        {
        }

        ~ListModeRequest()
        {
        }
};

class ListModeBase : public ModeHandler
{
 protected:
        std::string infokey;
        unsigned int listnumeric;
        unsigned int endoflistnumeric;
        std::string endofliststring;
        bool tidy;
        std::string configtag;
        limitlist chanlimits;
 
 public:
        ListModeBase(InspIRCd* Instance, char modechar, const std::string &eolstr, unsigned int lnum, unsigned int eolnum, bool autotidy, const std::string &ctag = "banlist")
        : ModeHandler(Instance, modechar, 1, 1, true, MODETYPE_CHANNEL, false), listnumeric(lnum), endoflistnumeric(eolnum), endofliststring(eolstr), tidy(autotidy), configtag(ctag)
        {
                this->DoRehash();
                infokey = "listbase_mode_" + std::string(1, mode) + "_list";
        }

        std::pair<bool,std::string> ModeSet(User*, User*, Channel* channel, const std::string &parameter)
        {
                modelist* el;
                channel->GetExt(infokey, el);
                if (el)
                {
                        for (modelist::iterator it = el->begin(); it != el->end(); it++)
                        {
                                if(parameter == it->mask)
                                {
                                        return std::make_pair(true, parameter);
                                }
                        }
                }
                return std::make_pair(false, parameter);
        }

        virtual void DisplayList(User* user, Channel* channel)
        {
                modelist* el;
                channel->GetExt(infokey, el);
                if (el)
                {
                        for (modelist::reverse_iterator it = el->rbegin(); it != el->rend(); ++it)
                        {
                                user->WriteNumeric(listnumeric, "%s %s %s %s %s", user->nick.c_str(), channel->name.c_str(), it->mask.c_str(), it->nick.c_str(), it->time.c_str());
                        }
                }
                user->WriteNumeric(endoflistnumeric, "%s %s :%s", user->nick.c_str(), channel->name.c_str(), endofliststring.c_str());
        }

        virtual void DisplayEmptyList(User* user, Channel* channel)
        {
                user->WriteNumeric(endoflistnumeric, "%s %s :%s", user->nick.c_str(), channel->name.c_str(), endofliststring.c_str());
        }

        virtual void RemoveMode(Channel* channel, irc::modestacker* stack)
        {
                modelist* el;
                channel->GetExt(infokey, el);
                if (el)
                {
                        irc::modestacker modestack(ServerInstance, false);
                        std::deque<std::string> stackresult;
                        std::vector<std::string> mode_junk;
                        mode_junk.push_back(channel->name);

                        for (modelist::iterator it = el->begin(); it != el->end(); it++)
                        {
                                if (stack)
                                        stack->Push(this->GetModeChar(), it->mask);
                                else
                                        modestack.Push(this->GetModeChar(), it->mask);
                        }

                        if (stack)
                                return;

                        while (modestack.GetStackedLine(stackresult))
                        {
                                for (size_t j = 0; j < stackresult.size(); j++)
                                {
                                        mode_junk.push_back(stackresult[j]);
                                }

                                ServerInstance->SendMode(mode_junk, ServerInstance->FakeClient);                
                        }
                }
        }

        virtual void RemoveMode(User*, irc::modestacker* stack)
        {
                /* Listmodes dont get set on users */
        }

        virtual void DoRehash()
        {
                ConfigReader Conf(ServerInstance);

                chanlimits.clear();

                for (int i = 0; i < Conf.Enumerate(configtag); i++)
                {
                        // For each <banlist> tag
                        ListLimit limit;
                        limit.mask = Conf.ReadValue(configtag, "chan", i);
                        limit.limit = Conf.ReadInteger(configtag, "limit", i, true);

                        if (limit.mask.size() && limit.limit > 0)
                                chanlimits.push_back(limit);
                }
                if (chanlimits.size() == 0)
                {
                        ListLimit limit;
                        limit.mask = "*";
                        limit.limit = 64;
                        chanlimits.push_back(limit);
                }
        }

        virtual void DoImplements(Module* m)
        {
                Implementation eventlist[] = { I_OnChannelDelete, I_OnSyncChannel, I_OnCleanup, I_OnRehash };
                ServerInstance->Modules->Attach(eventlist, m, 4);
        }

        virtual ModeAction OnModeChange(User* source, User*, Channel* channel, std::string &parameter, bool adding, bool servermode)
        {
                // Try and grab the list
                modelist* el;
                channel->GetExt(infokey, el);

                if (adding)
                {
                        // If there was no list
                        if (!el)
                        {
                                // Make one
                                el = new modelist;
                                channel->Extend(infokey, el);
                        }

                        // Clean the mask up
                        if (this->tidy)
                                ModeParser::CleanMask(parameter);

                        // Check if the item already exists in the list
                        for (modelist::iterator it = el->begin(); it != el->end(); it++)
                        {
                                if (parameter == it->mask)
                                {
                                        /* Give a subclass a chance to error about this */
                                        TellAlreadyOnList(source, channel, parameter);
                                        
                                        // it does, deny the change
                                        return MODEACTION_DENY;
                                }
                        }

                        unsigned int maxsize = 0;

                        for (limitlist::iterator it = chanlimits.begin(); it != chanlimits.end(); it++)
                        {
                                if (InspIRCd::Match(channel->name, it->mask))
                                {
                                        // We have a pattern matching the channel...
                                        maxsize = el->size();
                                        if (IS_LOCAL(source) || (maxsize < it->limit))
                                        {
                                                /* Ok, it *could* be allowed, now give someone subclassing us
                                                 * a chance to validate the parameter.
                                                 * The param is passed by reference, so they can both modify it
                                                 * and tell us if we allow it or not.
                                                 *
                                                 * eg, the subclass could:
                                                 * 1) allow
                                                 * 2) 'fix' parameter and then allow
                                                 * 3) deny
                                                 */
                                                if (ValidateParam(source, channel, parameter))
                                                {
                                                        // And now add the mask onto the list...
                                                        ListItem e;
                                                        e.mask = parameter;
                                                        e.nick = servermode ? ServerInstance->Config->ServerName : source->nick;
                                                        e.time = stringtime();

                                                        el->push_back(e);
                                                        return MODEACTION_ALLOW;
                                                }
                                                else
                                                {
                                                        /* If they deny it they have the job of giving an error message */
                                                        return MODEACTION_DENY;
                                                }
                                        }
                                }
                        }

                        /* List is full, give subclass a chance to send a custom message */
                        if (!TellListTooLong(source, channel, parameter))
                        {
                                source->WriteNumeric(478, "%s %s %s :Channel ban/ignore list is full", source->nick.c_str(), channel->name.c_str(), parameter.c_str());
                        }
                        
                        parameter = "";
                        return MODEACTION_DENY; 
                }
                else
                {
                        // We're taking the mode off
                        if (el)
                        {
                                for (modelist::iterator it = el->begin(); it != el->end(); it++)
                                {
                                        if (parameter == it->mask)
                                        {
                                                el->erase(it);
                                                if (el->size() == 0)
                                                {
                                                        channel->Shrink(infokey);
                                                        delete el;
                                                }
                                                return MODEACTION_ALLOW;
                                        }
                                }
                                /* Tried to remove something that wasn't set */
                                TellNotSet(source, channel, parameter);
                                parameter = "";
                                return MODEACTION_DENY;
                        }
                        else
                        {
                                /* Hmm, taking an exception off a non-existant list, DIE */
                                TellNotSet(source, channel, parameter);
                                parameter = "";
                                return MODEACTION_DENY;
                        }
                }
                return MODEACTION_DENY;
        }

        virtual std::string& GetInfoKey()
        {
                return infokey;
        }

        virtual void DoChannelDelete(Channel* chan)
        {
                modelist* mlist;
                chan->GetExt(infokey, mlist);

                if (mlist)
                {
                        chan->Shrink(infokey);
                        delete mlist;
                }
        }

        virtual void DoSyncChannel(Channel* chan, Module* proto, void* opaque)
        {
                modelist* mlist;
                chan->GetExt(infokey, mlist);
                irc::modestacker modestack(ServerInstance, true);
                std::deque<std::string> stackresult;
                if (mlist)
                {
                        for (modelist::iterator it = mlist->begin(); it != mlist->end(); it++)
                        {
                                modestack.Push(std::string(1, mode)[0], it->mask);
                        }
                }
                while (modestack.GetStackedLine(stackresult))
                {
                        irc::stringjoiner mode_join(" ", stackresult, 0, stackresult.size() - 1);
                        std::string line = mode_join.GetJoined();
                        proto->ProtoSendMode(opaque, TYPE_CHANNEL, chan, line);
                }
        }

        virtual void DoCleanup(int, void*)
        {
        }
        
        virtual bool ValidateParam(User*, Channel*, std::string&)
        {
                return true;
        }
        
        virtual bool TellListTooLong(User*, Channel*, std::string&)
        {
                return false;
        }
        
        virtual void TellAlreadyOnList(User*, Channel*, std::string&)
        {
        }
        
        virtual void TellNotSet(User*, Channel*, std::string&)
        {
        }
};

#endif