include/uid.h

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2007 Robin Burchell <robin+git@viroteck.net>
   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 #pragma once
  20
  21 class CoreExport UIDGenerator
  22 {
  23  private:
  24         /** Holds the current UID. Used to generate the next one.
  25          */
  26         std::string current_uid;
  27
  28         /** Increments the current UID by one.
  29          */
  30         void IncrementUID(unsigned int pos);
  31
  32  public:
  33         /**
  34         * This is the maximum length of a UUID (unique user identifier).
  35         * This length is set in compliance with TS6 protocol, and really should not be changed. Ever.
  36         * It allows for a lot of clients as-is. -- w00t.
  37         */
  38         static const unsigned int UUID_LENGTH = 9;
  39
  40         /** Initializes this UID generator with the given SID
  41          * @param sid SID that conforms to InspIRCd::IsSID()
  42          */
  43         void init(const std::string& sid);
  44
  45         /** Returns the next available UID for this server.
  46          */
  47         std::string GetUID();
  48
  49         /** Generates a pseudorandom SID based on a servername and a description
  50          * Guaranteed to return the same if invoked with the same parameters
  51          * @param servername The server name to use as seed
  52          * @param serverdesc The server description to use as seed
  53          * @return A valid SID
  54          */
  55         static std::string GenerateSID(const std::string& servername, const std::string& serverdesc);
  56 };