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