include/isupportmanager.h

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