X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Flistmode.h;h=f978e9c9a39529afb3f7c219a4f72c34c569efd3;hb=d23c030c9a8fd58807438245a004e4aa5b7288ba;hp=40c28f67f076d1a87b109b05dd92ba020304107f;hpb=ebe5b201aab71cf2ead1e068889be736314fbb73;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/listmode.h b/include/listmode.h index 40c28f67f..f978e9c9a 100644 --- a/include/listmode.h +++ b/include/listmode.h @@ -16,40 +16,71 @@ * along with this program. If not, see . */ + #pragma once /** The base class for list modes, should be inherited. */ -class ListModeBase : public ModeHandler +class CoreExport ListModeBase : public ModeHandler { public: /** An item in a listmode's list */ - class ListItem + struct ListItem { - public: - std::string nick; + std::string setter; std::string mask; - std::string time; + time_t time; + ListItem(const std::string& Mask, const std::string& Setter, time_t Time) + : setter(Setter), mask(Mask), time(Time) { } }; /** Items stored in the channel's list */ - typedef std::list ModeList; + typedef std::vector ModeList; private: + class ChanData + { + public: + ModeList list; + int maxitems; + + ChanData() : maxitems(-1) { } + }; + /** The number of items a listmode's list may contain */ - class ListLimit + struct ListLimit { - public: std::string mask; unsigned int limit; + ListLimit(const std::string& Mask, unsigned int Limit) : mask(Mask), limit(Limit) { } + bool operator==(const ListLimit& other) const { return (this->mask == other.mask && this->limit == other.limit); } }; /** Max items per channel by name */ - typedef std::list limitlist; + typedef std::vector limitlist; + + /** The default maximum list size. */ + static const unsigned int DEFAULT_LIST_SIZE = 100; + + /** Finds the limit of modes that can be placed on the given channel name according to the config + * @param channame The channel name to find the limit for + * @return The maximum number of modes of this type that we allow to be set on the given channel name + */ + unsigned int FindLimit(const std::string& channame); + + /** Returns the limit on the given channel for this mode. + * If the limit is cached then the cached value is returned, + * otherwise the limit is determined using FindLimit() and cached + * for later queries before it is returned + * @param channame The channel name to find the limit for + * @param cd The ChanData associated with channel channame + * @return The maximum number of modes of this type that we allow to be set on the given channel + */ + unsigned int GetLimitInternal(const std::string& channame, ChanData* cd); protected: /** Numeric to use when outputting the list @@ -74,11 +105,12 @@ class ListModeBase : public ModeHandler /** Storage key */ - SimpleExtItem extItem; + SimpleExtItem extItem; public: /** Constructor. - * @param Instance The creator of this class + * @param Creator The creator of this class + * @param Name Mode name * @param modechar Mode character * @param eolstr End of list string * @param lnum List numeric @@ -94,6 +126,10 @@ class ListModeBase : public ModeHandler */ unsigned int GetLimit(Channel* channel); + /** Gets the lower list limit for this listmode. + */ + unsigned int GetLowerLimit(); + /** Retrieves the list of all modes set on the given channel * @param channel Channel to get the list from * @return A list with all modes of this type set on the given channel, can be NULL @@ -116,39 +152,26 @@ class ListModeBase : public ModeHandler virtual void DisplayEmptyList(User* user, Channel* channel); /** Remove all instances of the mode from a channel. - * See mode.h + * Populates the given modestack with modes that remove every instance of + * this mode from the channel. + * See mode.h for more details. * @param channel The channel to remove all instances of the mode from + * @param changelist Mode change list to populate with the removal of this mode */ - virtual void RemoveMode(Channel* channel, irc::modestacker* stack); - - /** Listmodes don't get set on users, no-op - */ - virtual void RemoveMode(User*, irc::modestacker* stack); + virtual void RemoveMode(Channel* channel, Modes::ChangeList& changelist); /** Perform a rehash of this mode's configuration data */ - virtual void DoRehash(); - - /** Populate the Implements list with the correct events for a List Mode - */ - virtual void DoImplements(Module* m); + void DoRehash(); /** Handle the list mode. * See mode.h */ virtual ModeAction OnModeChange(User* source, User*, Channel* channel, std::string ¶meter, bool adding); - /** Syncronize channel item list with another server. - * See modules.h - * @param chan Channel to syncronize - * @param proto Protocol module pointer - * @param opaque Opaque connection handle - */ - virtual void DoSyncChannel(Channel* chan, Module* proto, void* opaque); - /** Validate parameters. * Overridden by implementing module. - * @param source Source user adding the parameter + * @param user Source user adding the parameter * @param channel Channel the parameter is being added to * @param parameter The actual parameter being added * @return true if the parameter is valid @@ -182,5 +205,9 @@ class ListModeBase : public ModeHandler inline ListModeBase::ModeList* ListModeBase::GetList(Channel* channel) { - return extItem.get(channel); + ChanData* cd = extItem.get(channel); + if (!cd) + return NULL; + + return &cd->list; }