include/uid.h

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2013, 2019 Sadie Powell <sadie@witchery.services>
   5  *   Copyright (C) 2013 Attila Molnar <attilamolnar@hush.com>
   6  *   Copyright (C) 2012 Robby <robby@chatbelgie.be>
   7  *   Copyright (C) 2010 Craig Edwards <brain@inspircd.org>
   8  *   Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
   9  *
  10  * This file is part of InspIRCd.  InspIRCd is free software: you can
  11  * redistribute it and/or modify it under the terms of the GNU General Public
  12  * License as published by the Free Software Foundation, version 2.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  */
  22
  23 #pragma once
  24
  25 class CoreExport UIDGenerator
  26 {
  27  private:
  28         /** Holds the current UID. Used to generate the next one.
  29          */
  30         std::string current_uid;
  31
  32         /** Increments the current UID by one.
  33          */
  34         void IncrementUID(unsigned int pos);
  35
  36  public:
  37         /**
  38         * This is the maximum length of a UUID (unique user identifier).
  39         * This length is set in compliance with TS6 protocol, and really should not be changed. Ever.
  40         * It allows for a lot of clients as-is. -- w00t.
  41         */
  42         static const unsigned int UUID_LENGTH = 9;
  43
  44         /** Initializes this UID generator with the given SID
  45          * @param sid SID that conforms to InspIRCd::IsSID()
  46          */
  47         void init(const std::string& sid);
  48
  49         /** Returns the next available UID for this server.
  50          */
  51         std::string GetUID();
  52
  53         /** Generates a pseudorandom SID based on a servername and a description
  54          * Guaranteed to return the same if invoked with the same parameters
  55          * @param servername The server name to use as seed
  56          * @param serverdesc The server description to use as seed
  57          * @return A valid SID
  58          */
  59         static std::string GenerateSID(const std::string& servername, const std::string& serverdesc);
  60 };