include/hashcomp.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
   6  * See: http://www.inspircd.org/wiki/index.php/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *          the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #ifndef _HASHCOMP_H_
  15 #define _HASHCOMP_H_
  16
  17 #include "inspircd_config.h"
  18 #include "socket.h"
  19 #include "hash_map.h"
  20
  21 /*******************************************************
  22  * This file contains classes and templates that deal
  23  * with the comparison and hashing of 'irc strings'.
  24  * An 'irc string' is a string which compares in a
  25  * case insensitive manner, and as per RFC 1459 will
  26  * treat [ identical to {, ] identical to }, and \
  27  * as identical to |.
  28  *
  29  * Our hashing functions are designed  to accept
  30  * std::string and compare/hash them as type irc::string
  31  * by converting them internally. This makes them
  32  * backwards compatible with other code which is not
  33  * aware of irc::string.
  34  *******************************************************/
  35
  36 using namespace std;
  37 using irc::sockets::insp_aton;
  38 using irc::sockets::insp_ntoa;
  39
  40 #ifndef LOWERMAP
  41 #define LOWERMAP
  42 /** A mapping of uppercase to lowercase, including scandinavian
  43  * 'oddities' as specified by RFC1459, e.g. { -> [, and | -> \
  44  */
  45 unsigned const char lowermap[256] = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19,                             /* 0-19 */
  46                                 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39,                         /* 20-39 */
  47                                 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59,                         /* 40-59 */
  48                                 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111,             /* 60-79 */
  49                                 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 94, 95, 96, 97, 98, 99,           /* 80-99 */
  50                                 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119,     /* 100-119 */
  51                                 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139,     /* 120-139 */
  52                                 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159,     /* 140-159 */
  53                                 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179,     /* 160-179 */
  54                                 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199,     /* 180-199 */
  55                                 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219,     /* 200-219 */
  56                                 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239,     /* 220-239 */
  57                                 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254, 255                          /* 240-255 */
  58 };
  59 #endif
  60
  61 /** The irc namespace contains a number of helper classes.
  62  */
  63 namespace irc
  64 {
  65
  66         /** This class returns true if two strings match.
  67          * Case sensitivity is ignored, and the RFC 'character set'
  68          * is adhered to
  69          */
  70         struct StrHashComp
  71         {
  72                 /** The operator () does the actual comparison in hash_map
  73                  */
  74                 bool operator()(const std::string& s1, const std::string& s2) const;
  75         };
  76
  77         /** The irc_char_traits class is used for RFC-style comparison of strings.
  78          * This class is used to implement irc::string, a case-insensitive, RFC-
  79          * comparing string class.
  80          */
  81         struct irc_char_traits : std::char_traits<char> {
  82
  83                 /** Check if two chars match
  84                  */
  85                 static bool eq(char c1st, char c2nd);
  86
  87                 /** Check if two chars do NOT match
  88                  */
  89                 static bool ne(char c1st, char c2nd);
  90
  91                 /** Check if one char is less than another
  92                  */
  93                 static bool lt(char c1st, char c2nd);
  94
  95                 /** Compare two strings of size n
  96                  */
  97                 static CoreExport int compare(const char* str1, const char* str2, size_t n);
  98
  99                 /** Find a char within a string up to position n
 100                  */
 101                 static CoreExport const char* find(const char* s1, int  n, char c);
 102         };
 103
 104         CoreExport std::string hex(const unsigned char *raw, size_t rawsz);
 105
 106         /** This typedef declares irc::string based upon irc_char_traits
 107          */
 108         typedef basic_string<char, irc_char_traits, allocator<char> > string;
 109
 110         /** irc::stringjoiner joins string lists into a string, using
 111          * the given seperator string.
 112          * This class can join a vector of std::string, a deque of
 113          * std::string, or a const char** array, using overloaded
 114          * constructors.
 115          */
 116         class CoreExport stringjoiner
 117         {
 118          private:
 119                 /** Output string
 120                  */
 121                 std::string joined;
 122          public:
 123                 /** Join elements of a vector, between (and including) begin and end
 124                  * @param seperator The string to seperate values with
 125                  * @param sequence One or more items to seperate
 126                  * @param begin The starting element in the sequence to be joined
 127                  * @param end The ending element in the sequence to be joined
 128                  */
 129                 stringjoiner(const std::string &seperator, const std::vector<std::string> &sequence, int begin, int end);
 130                 /** Join elements of a deque, between (and including) begin and end
 131                  * @param seperator The string to seperate values with
 132                  * @param sequence One or more items to seperate
 133                  * @param begin The starting element in the sequence to be joined
 134                  * @param end The ending element in the sequence to be joined
 135                  */
 136                 stringjoiner(const std::string &seperator, const std::deque<std::string> &sequence, int begin, int end);
 137                 /** Join elements of an array of char arrays, between (and including) begin and end
 138                  * @param seperator The string to seperate values with
 139                  * @param sequence One or more items to seperate
 140                  * @param begin The starting element in the sequence to be joined
 141                  * @param end The ending element in the sequence to be joined
 142                  */
 143                 stringjoiner(const std::string &seperator, const char** sequence, int begin, int end);
 144
 145                 /** Get the joined sequence
 146                  * @return A reference to the joined string
 147                  */
 148                 std::string& GetJoined();
 149         };
 150
 151         /** irc::modestacker stacks mode sequences into a list.
 152          * It can then reproduce this list, clamped to a maximum of MAXMODES
 153          * values per line.
 154          */
 155         class CoreExport modestacker
 156         {
 157          private:
 158                 /** The mode sequence and its parameters
 159                  */
 160                 std::deque<std::string> sequence;
 161                 /** True if the mode sequence is initially adding
 162                  * characters, false if it is initially removing
 163                  * them
 164                  */
 165                 bool adding;
 166          public:
 167                 /** Construct a new modestacker.
 168                  * @param add True if the stack is adding modes,
 169                  * false if it is removing them
 170                  */
 171                 modestacker(bool add);
 172                 /** Push a modeletter and its parameter onto the stack.
 173                  * No checking is performed as to if this mode actually
 174                  * requires a parameter. If you stack invalid mode
 175                  * sequences, they will be tidied if and when they are
 176                  * passed to a mode parser.
 177                  * @param modeletter The mode letter to insert
 178                  * @param parameter The parameter for the mode
 179                  */
 180                 void Push(char modeletter, const std::string &parameter);
 181                 /** Push a modeletter without parameter onto the stack.
 182                  * No checking is performed as to if this mode actually
 183                  * requires a parameter. If you stack invalid mode
 184                  * sequences, they will be tidied if and when they are
 185                  * passed to a mode parser.
 186                  * @param modeletter The mode letter to insert
 187                  */
 188                 void Push(char modeletter);
 189                 /** Push a '+' symbol onto the stack.
 190                  */
 191                 void PushPlus();
 192                 /** Push a '-' symbol onto the stack.
 193                  */
 194                 void PushMinus();
 195                 /** Return zero or more elements which form the
 196                  * mode line. This will be clamped to a max of
 197                  * MAXMODES+1 items (MAXMODES mode parameters and
 198                  * one mode sequence string), and max_line_size
 199                  * characters. As specified below, this function
 200                  * should be called in a loop until it returns zero,
 201                  * indicating there are no more modes to return.
 202                  * @param result The deque to populate. This will
 203                  * be cleared before it is used.
 204                  * @param max_line_size The maximum size of the line
 205                  * to build, in characters, seperate to MAXMODES.
 206                  * @return The number of elements in the deque.
 207                  * The function should be called repeatedly until it
 208                  * returns 0, in case there are multiple lines of
 209                  * mode changes to be obtained.
 210                  */
 211                 int GetStackedLine(std::deque<std::string> &result, int max_line_size = 360);
 212         };
 213
 214         /** irc::tokenstream reads a string formatted as per RFC1459 and RFC2812.
 215          * It will split the string into 'tokens' each containing one parameter
 216          * from the string.
 217          * For instance, if it is instantiated with the string:
 218          * "PRIVMSG #test :foo bar baz qux"
 219          * then each successive call to tokenstream::GetToken() will return
 220          * "PRIVMSG", "#test", "foo bar baz qux", "".
 221          * Note that if the whole string starts with a colon this is not taken
 222          * to mean the string is all one parameter, and the first item in the
 223          * list will be ":item". This is to allow for parsing 'source' fields
 224          * from data.
 225          */
 226         class CoreExport tokenstream
 227         {
 228          private:
 229                 /** Original string
 230                  */
 231                 std::string tokens;
 232                 /** Last position of a seperator token
 233                  */
 234                 std::string::iterator last_starting_position;
 235                 /** Current string position
 236                  */
 237                 std::string::iterator n;
 238                 /** True if the last value was an ending value
 239                  */
 240                 bool last_pushed;
 241          public:
 242                 /** Create a tokenstream and fill it with the provided data
 243                  */
 244                 tokenstream(const std::string &source);
 245                 ~tokenstream();
 246
 247                 /** Fetch the next token from the stream
 248                  * @return The next token is returned, or an empty string if none remain
 249                  */
 250                 bool GetToken(std::string &token);
 251                 bool GetToken(irc::string &token);
 252                 bool GetToken(int &token);
 253                 bool GetToken(long &token);
 254         };
 255
 256         /** irc::sepstream allows for splitting token seperated lists.
 257          * Each successive call to sepstream::GetToken() returns
 258          * the next token, until none remain, at which point the method returns
 259          * an empty string.
 260          */
 261         class CoreExport sepstream : public classbase
 262         {
 263          private:
 264                 /** Original string
 265                  */
 266                 std::string tokens;
 267                 /** Last position of a seperator token
 268                  */
 269                 std::string::iterator last_starting_position;
 270                 /** Current string position
 271                  */
 272                 std::string::iterator n;
 273                 /** Seperator value
 274                  */
 275                 char sep;
 276          public:
 277                 /** Create a sepstream and fill it with the provided data
 278                  */
 279                 sepstream(const std::string &source, char seperator);
 280                 virtual ~sepstream();
 281
 282                 /** Fetch the next token from the stream
 283                  * @return The next token is returned, or an empty string if none remain
 284                  */
 285                 virtual const std::string GetToken();
 286
 287                 /** Fetch the entire remaining stream, without tokenizing
 288                  * @return The remaining part of the stream
 289                  */
 290                 virtual const std::string GetRemaining();
 291
 292                 /** Returns true if the end of the stream has been reached
 293                  * @return True if the end of the stream has been reached, otherwise false
 294                  */
 295                 virtual bool StreamEnd();
 296         };
 297
 298         /** A derived form of sepstream, which seperates on commas
 299          */
 300         class CoreExport commasepstream : public sepstream
 301         {
 302          public:
 303                 commasepstream(const std::string &source) : sepstream(source, ',')
 304                 {
 305                 }
 306         };
 307
 308         /** A derived form of sepstream, which seperates on spaces
 309          */
 310         class CoreExport spacesepstream : public sepstream
 311         {
 312          public:
 313                 spacesepstream(const std::string &source) : sepstream(source, ' ')
 314                 {
 315                 }
 316         };
 317
 318         /** The portparser class seperates out a port range into integers.
 319          * A port range may be specified in the input string in the form
 320          * "6660,6661,6662-6669,7020". The end of the stream is indicated by
 321          * a return value of 0 from portparser::GetToken(). If you attempt
 322          * to specify an illegal range (e.g. one where start >= end, or
 323          * start or end < 0) then GetToken() will return the first element
 324          * of the pair of numbers.
 325          */
 326         class CoreExport portparser : public classbase
 327         {
 328          private:
 329                 /** Used to split on commas
 330                  */
 331                 commasepstream* sep;
 332                 /** Current position in a range of ports
 333                  */
 334                 long in_range;
 335                 /** Starting port in a range of ports
 336                  */
 337                 long range_begin;
 338                 /** Ending port in a range of ports
 339                  */
 340                 long range_end;
 341                 /** Allow overlapped port ranges
 342                  */
 343                 bool overlapped;
 344                 /** Used to determine overlapping of ports
 345                  * without O(n) algorithm being used
 346                  */
 347                 std::map<long, bool> overlap_set;
 348                 /** Returns true if val overlaps an existing range
 349                  */
 350                 bool Overlaps(long val);
 351          public:
 352                 /** Create a portparser and fill it with the provided data
 353                  * @param source The source text to parse from
 354                  * @param allow_overlapped Allow overlapped ranges
 355                  */
 356                 portparser(const std::string &source, bool allow_overlapped = true);
 357                 /** Frees the internal commasepstream object
 358                  */
 359                 ~portparser();
 360                 /** Fetch the next token from the stream
 361                  * @return The next port number is returned, or 0 if none remain
 362                  */
 363                 long GetToken();
 364         };
 365
 366         /** Used to hold a bitfield definition in dynamicbitmask.
 367          * You must be allocated one of these by dynamicbitmask::Allocate(),
 368          * you should not fill the values yourself!
 369          */
 370         typedef std::pair<size_t, unsigned char> bitfield;
 371
 372         /** The irc::dynamicbitmask class is used to maintain a bitmap of
 373          * boolean values, which can grow to any reasonable size no matter
 374          * how many bitfields are in it.
 375          *
 376          * It starts off at 32 bits in size, large enough to hold 32 boolean
 377          * values, with a memory allocation of 8 bytes. If you allocate more
 378          * than 32 bits, the class will grow the bitmap by 8 bytes at a time
 379          * for each set of 8 bitfields you allocate with the Allocate()
 380          * method.
 381          *
 382          * This method is designed so that multiple modules can be allocated
 383          * bit values in a bitmap dynamically, rather than having to define
 384          * costs in a fixed size unsigned integer and having the possibility
 385          * of collisions of values in different third party modules.
 386          *
 387          * IMPORTANT NOTE:
 388          *
 389          * To use this class, you must derive from it.
 390          * This is because each derived instance has its own freebits array
 391          * which can determine what bitfields are allocated on a TYPE BY TYPE
 392          * basis, e.g. an irc::dynamicbitmask type for userrecs, and one for
 393          * chanrecs, etc. You should inheret it in a very simple way as follows.
 394          * The base class will resize and maintain freebits as required, you are
 395          * just required to make the pointer static and specific to this class
 396          * type.
 397          *
 398          * \code
 399          * class mydbitmask : public irc::dynamicbitmask
 400          * {
 401          *  private:
 402          *
 403          *      static unsigned char* freebits;
 404          *
 405          *  public:
 406          *
 407          *      mydbitmask() : irc::dynamicbitmask()
 408          *      {
 409          *        freebits = new unsigned char[this->bits_size];
 410          *        memset(freebits, 0, this->bits_size);
 411          *      }
 412          *
 413          *      ~mydbitmask()
 414          *      {
 415          *        delete[] freebits;
 416          *      }
 417          *
 418          *      unsigned char* GetFreeBits()
 419          *      {
 420          *        return freebits;
 421          *      }
 422          *
 423          *      void SetFreeBits(unsigned char* freebt)
 424          *      {
 425          *        freebits = freebt;
 426          *      }
 427          * };
 428          * \endcode
 429          */
 430         class CoreExport dynamicbitmask : public classbase
 431         {
 432          private:
 433                 /** Data bits. We start with four of these,
 434                  * and we grow the bitfield as we allocate
 435                  * more than 32 entries with Allocate().
 436                  */
 437                 unsigned char* bits;
 438          protected:
 439                 /** Current set size (size of freebits and bits).
 440                  * Both freebits and bits will ALWAYS be the
 441                  * same length.
 442                  */
 443                 unsigned char bits_size;
 444          public:
 445                 /** Allocate the initial memory for bits and
 446                  * freebits and zero the memory.
 447                  */
 448                 dynamicbitmask();
 449
 450                 /** Free the memory used by bits and freebits
 451                  */
 452                 virtual ~dynamicbitmask();
 453
 454                 /** Allocate an irc::bitfield.
 455                  * @return An irc::bitfield which can be used
 456                  * with Get, Deallocate and Toggle methods.
 457                  * @throw Can throw std::bad_alloc if there is
 458                  * no ram left to grow the bitmask.
 459                  */
 460                 bitfield Allocate();
 461
 462                 /** Deallocate an irc::bitfield.
 463                  * @param An irc::bitfield to deallocate.
 464                  * @return True if the bitfield could be
 465                  * deallocated, false if it could not.
 466                  */
 467                 bool Deallocate(bitfield &pos);
 468
 469                 /** Toggle the value of a bitfield.
 470                  * @param pos A bitfield to allocate, previously
 471                  * allocated by dyamicbitmask::Allocate().
 472                  * @param state The state to set the field to.
 473                  */
 474                 void Toggle(bitfield &pos, bool state);
 475
 476                 /** Get the value of a bitfield.
 477                  * @param pos A bitfield to retrieve, previously
 478                  * allocated by dyamicbitmask::Allocate().
 479                  * @return The value of the bitfield.
 480                  * @throw Will throw ModuleException if the bitfield
 481                  * you provide is outside of the range
 482                  * 0 >= bitfield.first < size_bits.
 483                  */
 484                 bool Get(bitfield &pos);
 485
 486                 /** Return the size in bytes allocated to the bits
 487                  * array.
 488                  * Note that the actual allocation is twice this,
 489                  * as there are an equal number of bytes allocated
 490                  * for the freebits array.
 491                  */
 492                 unsigned char GetSize();
 493
 494                 virtual unsigned char* GetFreeBits() { return NULL; }
 495
 496                 virtual void SetFreeBits(unsigned char* freebits) { }
 497         };
 498
 499         CoreExport const char* Spacify(const char* n);
 500 }
 501
 502 /* Define operators for using >> and << with irc::string to an ostream on an istream. */
 503 /* This was endless fun. No. Really. */
 504 /* It was also the first core change Ommeh made, if anyone cares */
 505 inline std::ostream& operator<<(std::ostream &os, const irc::string &str) { return os << str.c_str(); }
 506 inline std::istream& operator>>(std::istream &is, irc::string &str)
 507 {
 508         std::string tmp;
 509         is >> tmp;
 510         str = tmp.c_str();
 511         return is;
 512 }
 513
 514 /* Define operators for + and == with irc::string to std::string for easy assignment
 515  * and comparison - Brain
 516  */
 517 inline std::string operator+ (std::string& leftval, irc::string& rightval)
 518 {
 519         return leftval + std::string(rightval.c_str());
 520 }
 521
 522 inline irc::string operator+ (irc::string& leftval, std::string& rightval)
 523 {
 524         return leftval + irc::string(rightval.c_str());
 525 }
 526
 527 inline bool operator== (const std::string& leftval, const irc::string& rightval)
 528 {
 529         return (leftval.c_str() == rightval);
 530 }
 531
 532 inline bool operator== (const irc::string& leftval, const std::string& rightval)
 533 {
 534         return (leftval == rightval.c_str());
 535 }
 536
 537 inline std::string assign(const irc::string &other) { return other.c_str(); }
 538 inline irc::string assign(const std::string &other) { return other.c_str(); }
 539 inline std::string& trim(std::string &str)
 540 {
 541         std::string::size_type start = str.find_first_not_of(" ");
 542         std::string::size_type end = str.find_last_not_of(" ");
 543         if (start == std::string::npos || end == std::string::npos)
 544                 str = "";
 545         else
 546                 str = str.substr(start, end-start+1);
 547
 548         return str;
 549 }
 550
 551 /* Hashing stuff is totally different on vc++'s hash_map implementation, so to save a buttload of #ifdefs we'll just
 552    do it all at once - Burlex */
 553
 554 namespace nspace
 555 {
 556         /** Hashing function to hash irc::string
 557          */
 558 #ifdef WINDOWS
 559         template<> class CoreExport hash_compare<irc::string, std::less<irc::string> >
 560         {
 561         public:
 562                 enum { bucket_size = 4, min_buckets = 8 };                      // Got these numbers from the CRT source,
 563                                                                                                                         // if anyone wants to change them feel free.
 564                 bool operator()(const irc::string & s1, const irc::string & s2) const
 565                 {
 566                         if(s1.length() != s2.length()) return true;
 567                         return (irc::irc_char_traits::compare(s1.c_str(), s2.c_str(), s1.length()) < 0);
 568                 }
 569
 570                 size_t operator()(const irc::string & s) const;
 571         };
 572
 573         template<> class CoreExport hash_compare<std::string, std::less<std::string> >
 574         {
 575         public:
 576                 enum { bucket_size = 4, min_buckets = 8 };
 577                 bool operator()(const std::string & s1, const std::string & s2) const
 578                 {
 579                         if(s1.length() != s2.length()) return true;
 580                         return (irc::irc_char_traits::compare(s1.c_str(), s2.c_str(), s1.length()) < 0);
 581                 }
 582
 583                 /** Hash a std::string using RFC1459 case sensitivity rules
 584                 * @param s A string to hash
 585                 * @return The hash value
 586                 */
 587                 size_t operator()(const std::string & s) const;
 588         };
 589 #else
 590         template<> struct hash<irc::string>
 591         {
 592                 size_t operator()(const irc::string &s) const;
 593         };
 594
 595         template<> struct hash<std::string>
 596         {
 597                 /** Hash a std::string using RFC1459 case sensitivity rules
 598                 * @param s A string to hash
 599                 * @return The hash value
 600                 */
 601                 size_t operator()(const string &s) const;
 602         };
 603 #endif
 604
 605         /** Convert a string to lower case respecting RFC1459
 606         * @param n A string to lowercase
 607         */
 608         void strlower(char *n);
 609 }
 610
 611 #endif