include/builtinmodes.h

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
   5  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
   6  *   Copyright (C) 2006 Craig Edwards <craigedwards@brainbox.cc>
   7  *
   8  * This file is part of InspIRCd.  InspIRCd is free software: you can
   9  * redistribute it and/or modify it under the terms of the GNU General Public
  10  * License as published by the Free Software Foundation, version 2.
  11  *
  12  * This program is distributed in the hope that it will be useful, but WITHOUT
  13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  14  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  15  * details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 #pragma once
  22
  23 #include "mode.h"
  24 #include "channels.h"
  25 #include "listmode.h"
  26
  27 /** Channel mode +b
  28  */
  29 class ModeChannelBan : public ListModeBase
  30 {
  31  public:
  32         ModeChannelBan()
  33                 : ListModeBase(NULL, "ban", 'b', "End of channel ban list", 367, 368, true, "maxbans")
  34         {
  35         }
  36 };
  37
  38 /** Channel mode +k
  39  */
  40 class ModeChannelKey : public ParamMode<ModeChannelKey, LocalStringExt>
  41 {
  42         static const std::string::size_type maxkeylen = 32;
  43  public:
  44         ModeChannelKey();
  45         ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding);
  46         void SerializeParam(Channel* chan, const std::string* key, std::string& out);
  47         ModeAction OnSet(User* source, Channel* chan, std::string& param);
  48 };
  49
  50 /** Channel mode +l
  51  */
  52 class ModeChannelLimit : public ParamMode<ModeChannelLimit, LocalIntExt>
  53 {
  54  public:
  55         ModeChannelLimit();
  56         bool ResolveModeConflict(std::string &their_param, const std::string &our_param, Channel* channel);
  57         void SerializeParam(Channel* chan, intptr_t n, std::string& out);
  58         ModeAction OnSet(User* source, Channel* channel, std::string& parameter);
  59 };
  60
  61 /** Channel mode +o
  62  */
  63 class ModeChannelOp : public PrefixMode
  64 {
  65  public:
  66         ModeChannelOp()
  67                 : PrefixMode(NULL, "op", 'o', OP_VALUE, '@')
  68         {
  69                 levelrequired = OP_VALUE;
  70         }
  71 };
  72
  73 /** Channel mode +v
  74  */
  75 class ModeChannelVoice : public PrefixMode
  76 {
  77  public:
  78         ModeChannelVoice()
  79                 : PrefixMode(NULL, "voice", 'v', VOICE_VALUE, '+')
  80         {
  81                 levelrequired = HALFOP_VALUE;
  82         }
  83 };
  84
  85 /** User mode +s
  86  */
  87 class ModeUserServerNoticeMask : public ModeHandler
  88 {
  89         /** Process a snomask modifier string, e.g. +abc-de
  90          * @param user The target user
  91          * @param input A sequence of notice mask characters
  92          * @return The cleaned mode sequence which can be output,
  93          * e.g. in the above example if masks c and e are not
  94          * valid, this function will return +ab-d
  95          */
  96         std::string ProcessNoticeMasks(User* user, const std::string& input);
  97
  98  public:
  99         ModeUserServerNoticeMask();
 100         ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding);
 101         void OnParameterMissing(User* user, User* dest, Channel* channel);
 102
 103         /** Create a displayable mode string of the snomasks set on a given user
 104          * @param user The user whose notice masks to format
 105          * @return The notice mask character sequence
 106          */
 107         std::string GetUserParameter(User* user);
 108 };
 109
 110 /** User mode +o
 111  */
 112 class ModeUserOperator : public ModeHandler
 113 {
 114  public:
 115         ModeUserOperator();
 116         ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding);
 117 };