include/isupportmanager.h

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2013 Sadie Powell <sadie@witchery.services>
   5  *
   6  * This file is part of InspIRCd.  InspIRCd is free software: you can
   7  * redistribute it and/or modify it under the terms of the GNU General Public
   8  * License as published by the Free Software Foundation, version 2.
   9  *
  10  * This program is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  12  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  13  * details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19
  20 #pragma once
  21
  22 /** This class manages the generation and transmission of ISUPPORT. */
  23 class CoreExport ISupportManager
  24 {
  25  private:
  26         /** The generated lines which are sent to clients. */
  27         std::vector<Numeric::Numeric> cachedlines;
  28
  29         /** Escapes an ISUPPORT token value and appends it to the buffer.
  30          * @param buffer The buffer to append to.
  31          * @param value An ISUPPORT token value.
  32          */
  33         void AppendValue(std::string& buffer, const std::string& value);
  34
  35  public:
  36         /** (Re)build the ISUPPORT vector.
  37          * Called by the core on boot after all modules have been loaded, and every time when a module is loaded
  38          * or unloaded. Calls the On005Numeric hook, letting modules manipulate the ISUPPORT tokens.
  39          */
  40         void Build();
  41
  42         /** Returns the cached std::vector of ISUPPORT lines.
  43          * @return A list of Numeric::Numeric objects prepared for sending to users
  44          */
  45         const std::vector<Numeric::Numeric>& GetLines() const { return cachedlines; }
  46
  47         /** Send the 005 numerics (ISUPPORT) to a user.
  48          * @param user The user to send the ISUPPORT numerics to
  49          */
  50         void SendTo(LocalUser* user);
  51 };