]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/listmode.h
Merge tag 'v2.0.25' into master.
[user/henk/code/inspircd.git] / include / listmode.h
index c21f9b93fc81507ac4a563962c4e1d7fa4f4a3a9..f978e9c9a39529afb3f7c219a4f72c34c569efd3 100644 (file)
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+
 #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
@@ -36,9 +37,18 @@ class ListModeBase : public ModeHandler
 
        /** Items stored in the channel's list
         */
-       typedef std::list<ListItem> ModeList;
+       typedef std::vector<ListItem> ModeList;
 
  private:
+       class ChanData
+       {
+       public:
+               ModeList list;
+               int maxitems;
+
+               ChanData() : maxitems(-1) { }
+       };
+
        /** The number of items a listmode's list may contain
         */
        struct ListLimit
@@ -46,12 +56,32 @@ class ListModeBase : public ModeHandler
                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::vector<ListLimit> 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
         */
@@ -75,11 +105,12 @@ class ListModeBase : public ModeHandler
 
        /** Storage key
         */
-       SimpleExtItem<ModeList> extItem;
+       SimpleExtItem<ChanData> 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
@@ -95,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
@@ -117,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 &parameter, 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
@@ -183,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;
 }