include/hashcomp.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
   6  *                       E-mail:
   7  *                <brain@chatspike.net>
   8  *                <Craig@chatspike.net>
   9  *
  10  * Written by Craig Edwards, Craig McLure, and others.
  11  * This program is free but copyrighted software; see
  12  *            the file COPYING for details.
  13  *
  14  * ---------------------------------------------------
  15  */
  16
  17 #ifndef _HASHCOMP_H_
  18 #define _HASHCOMP_H_
  19
  20 #include "inspircd_config.h"
  21 #include "socket.h"
  22 #include "hash_map.h"
  23
  24 /*******************************************************
  25  * This file contains classes and templates that deal
  26  * with the comparison and hashing of 'irc strings'.
  27  * An 'irc string' is a string which compares in a
  28  * case insensitive manner, and as per RFC 1459 will
  29  * treat [ identical to {, ] identical to }, and \
  30  * as identical to |.
  31  *
  32  * Our hashing functions are designed  to accept
  33  * std::string and compare/hash them as type irc::string
  34  * by converting them internally. This makes them
  35  * backwards compatible with other code which is not
  36  * aware of irc::string.
  37  *******************************************************/
  38
  39 using namespace std;
  40 using irc::sockets::insp_aton;
  41 using irc::sockets::insp_ntoa;
  42 using irc::sockets::insp_inaddr;
  43
  44 #ifndef LOWERMAP
  45 #define LOWERMAP
  46 /** A mapping of uppercase to lowercase, including scandinavian
  47  * 'oddities' as specified by RFC1459, e.g. { -> [, and | -> \
  48  */
  49 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 */
  50                                 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39,                         /* 20-39 */
  51                                 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59,                         /* 40-59 */
  52                                 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111,             /* 60-79 */
  53                                 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 94, 95, 96, 97, 98, 99,           /* 80-99 */
  54                                 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119,     /* 100-119 */
  55                                 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139,     /* 120-139 */
  56                                 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159,     /* 140-159 */
  57                                 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179,     /* 160-179 */
  58                                 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199,     /* 180-199 */
  59                                 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219,     /* 200-219 */
  60                                 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239,     /* 220-239 */
  61                                 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254, 255                          /* 240-255 */
  62 };
  63 #endif
  64
  65 /** Because of weirdness in g++, before 3.x this was namespace std. It's now __gnu_cxx.
  66  * This is a #define'd alias.
  67  */
  68 namespace nspace
  69 {
  70         /** Convert a string to lower case respecting RFC1459
  71          * @param n A string to lowercase
  72          */
  73         void strlower(char *n);
  74
  75         /** Hashing function to hash insp_inaddr structs
  76          */
  77         template<> struct hash<insp_inaddr>
  78         {
  79                 /** Hash an insp_inaddr
  80                  * @param a An insp_inaddr to hash
  81                  * @return The hash value
  82                  */
  83                 size_t operator()(const insp_inaddr &a) const;
  84         };
  85
  86         /** Hashing function to hash std::string without respect to case
  87          */
  88         template<> struct hash<std::string>
  89         {
  90                 /** Hash a std::string using RFC1459 case sensitivity rules
  91                  * @param s A string to hash
  92                  * @return The hash value
  93                  */
  94                 size_t operator()(const string &s) const;
  95         };
  96 }
  97
  98 /** The irc namespace contains a number of helper classes.
  99  */
 100 namespace irc
 101 {
 102
 103         /** This class returns true if two strings match.
 104          * Case sensitivity is ignored, and the RFC 'character set'
 105          * is adhered to
 106          */
 107         struct StrHashComp
 108         {
 109                 /** The operator () does the actual comparison in hash_map
 110                  */
 111                 bool operator()(const std::string& s1, const std::string& s2) const;
 112         };
 113
 114
 115         /** This class returns true if two insp_inaddr structs match.
 116          * Checking is done by copying both into a size_t then doing a
 117          * numeric comparison of the two.
 118          */
 119         struct InAddr_HashComp
 120         {
 121                 /** The operator () does the actual comparison in hash_map
 122                  */
 123                 bool operator()(const insp_inaddr &s1, const insp_inaddr &s2) const;
 124         };
 125
 126         /** irc::stringjoiner joins string lists into a string, using
 127          * the given seperator string.
 128          * This class can join a vector of std::string, a deque of
 129          * std::string, or a const char** array, using overloaded
 130          * constructors.
 131          */
 132         class stringjoiner
 133         {
 134          private:
 135                 std::string joined;
 136          public:
 137                 /** Join elements of a vector, 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 std::vector<std::string> &sequence, int begin, int end);
 144                 /** Join elements of a deque, between (and including) begin and end
 145                  * @param seperator The string to seperate values with
 146                  * @param sequence One or more items to seperate
 147                  * @param begin The starting element in the sequence to be joined
 148                  * @param end The ending element in the sequence to be joined
 149                  */
 150                 stringjoiner(const std::string &seperator, const std::deque<std::string> &sequence, int begin, int end);
 151                 /** Join elements of an array of char arrays, between (and including) begin and end
 152                  * @param seperator The string to seperate values with
 153                  * @param sequence One or more items to seperate
 154                  * @param begin The starting element in the sequence to be joined
 155                  * @param end The ending element in the sequence to be joined
 156                  */
 157                 stringjoiner(const std::string &seperator, const char** sequence, int begin, int end);
 158
 159                 /** Get the joined sequence
 160                  * @return A reference to the joined string
 161                  */
 162                 std::string& GetJoined();
 163         };
 164
 165         /** irc::modestacker stacks mode sequences into a list.
 166          * It can then reproduce this list, clamped to a maximum of MAXMODES
 167          * values per line.
 168          */
 169         class modestacker
 170         {
 171          private:
 172                 /** The mode sequence and its parameters
 173                  */
 174                 std::deque<std::string> sequence;
 175                 /** True if the mode sequence is initially adding
 176                  * characters, false if it is initially removing
 177                  * them
 178                  */
 179                 bool adding;
 180          public:
 181                 /** Construct a new modestacker.
 182                  * @param add True if the stack is adding modes,
 183                  * false if it is removing them
 184                  */
 185                 modestacker(bool add);
 186                 /** Push a modeletter and its parameter onto the stack.
 187                  * No checking is performed as to if this mode actually
 188                  * requires a parameter. If you stack invalid mode
 189                  * sequences, they will be tidied if and when they are
 190                  * passed to a mode parser.
 191                  * @param modeletter The mode letter to insert
 192                  * @param parameter The parameter for the mode
 193                  */
 194                 void Push(char modeletter, const std::string &parameter);
 195                 /** Push a modeletter without parameter onto the stack.
 196                  * No checking is performed as to if this mode actually
 197                  * requires a parameter. If you stack invalid mode
 198                  * sequences, they will be tidied if and when they are
 199                  * passed to a mode parser.
 200                  * @param modeletter The mode letter to insert
 201                  */
 202                 void Push(char modeletter);
 203                 /** Push a '+' symbol onto the stack.
 204                  */
 205                 void PushPlus();
 206                 /** Push a '-' symbol onto the stack.
 207                  */
 208                 void PushMinus();
 209                 /** Return zero or more elements which form the
 210                  * mode line. This will be clamped to a max of
 211                  * MAXMODES+1 items (MAXMODES mode parameters and
 212                  * one mode sequence string).
 213                  * @param result The deque to populate. This will
 214                  * be cleared before it is used.
 215                  * @return The number of elements in the deque
 216                  */
 217                 int GetStackedLine(std::deque<std::string> &result);
 218         };
 219
 220         /** irc::tokenstream reads a string formatted as per RFC1459 and RFC2812.
 221          * It will split the string into 'tokens' each containing one parameter
 222          * from the string.
 223          * For instance, if it is instantiated with the string:
 224          * "PRIVMSG #test :foo bar baz qux"
 225          * then each successive call to tokenstream::GetToken() will return
 226          * "PRIVMSG", "#test", "foo bar baz qux", "".
 227          * Note that if the whole string starts with a colon this is not taken
 228          * to mean the string is all one parameter, and the first item in the
 229          * list will be ":item". This is to allow for parsing 'source' fields
 230          * from data.
 231          */
 232         class tokenstream
 233         {
 234          private:
 235                 std::string tokens;
 236                 std::string::iterator last_starting_position;
 237                 std::string::iterator n;
 238                 bool last_pushed;
 239          public:
 240                 /** Create a tokenstream and fill it with the provided data
 241                  */
 242                 tokenstream(const std::string &source);
 243                 ~tokenstream();
 244
 245                 /** Fetch the next token from the stream
 246                  * @returns The next token is returned, or an empty string if none remain
 247                  */
 248                 const std::string GetToken();
 249         };
 250
 251         /** irc::commasepstream allows for splitting comma seperated lists.
 252          * Lists passed to irc::commasepstream should not contain spaces
 253          * after the commas, or this will be taken to be part of the item
 254          * data. Each successive call to commasepstream::GetToken() returns
 255          * the next token, until none remain, at which point the method returns
 256          * an empty string.
 257          */
 258         class sepstream : public classbase
 259         {
 260          private:
 261                 std::string tokens;
 262                 std::string::iterator last_starting_position;
 263                 std::string::iterator n;
 264                 char sep;
 265          public:
 266                 /** Create a commasepstream and fill it with the provided data
 267                  */
 268                 sepstream(const std::string &source, char seperator);
 269                 virtual ~sepstream();
 270
 271                 /** Fetch the next token from the stream
 272                  * @returns The next token is returned, or an empty string if none remain
 273                  */
 274                 virtual const std::string GetToken();
 275         };
 276
 277         class commasepstream : public sepstream
 278         {
 279          public:
 280                 commasepstream(const std::string &source) : sepstream(source, ',')
 281                 {
 282                 }
 283         };
 284
 285         class spacesepstream : public sepstream
 286         {
 287          public:
 288                 spacesepstream(const std::string &source) : sepstream(source, ' ')
 289                 {
 290                 }
 291         };
 292
 293
 294         /** The irc_char_traits class is used for RFC-style comparison of strings.
 295          * This class is used to implement irc::string, a case-insensitive, RFC-
 296          * comparing string class.
 297          */
 298         struct irc_char_traits : std::char_traits<char> {
 299
 300                 /** Check if two chars match
 301                  */
 302                 static bool eq(char c1st, char c2nd);
 303
 304                 /** Check if two chars do NOT match
 305                  */
 306                 static bool ne(char c1st, char c2nd);
 307
 308                 /** Check if one char is less than another
 309                  */
 310                 static bool lt(char c1st, char c2nd);
 311
 312                 /** Compare two strings of size n
 313                  */
 314                 static int compare(const char* str1, const char* str2, size_t n);
 315
 316                 /** Find a char within a string up to position n
 317                  */
 318                 static const char* find(const char* s1, int  n, char c);
 319         };
 320
 321         std::string hex(const unsigned char *raw, size_t rawsz);
 322
 323         /** This typedef declares irc::string based upon irc_char_traits
 324          */
 325         typedef basic_string<char, irc_char_traits, allocator<char> > string;
 326
 327         const char* Spacify(char* n);
 328 }
 329
 330 /* Define operators for using >> and << with irc::string to an ostream on an istream. */
 331 /* This was endless fun. No. Really. */
 332 /* It was also the first core change Ommeh made, if anyone cares */
 333 std::ostream& operator<<(std::ostream &os, const irc::string &str);
 334 std::istream& operator>>(std::istream &is, irc::string &str);
 335
 336 /* Define operators for + and == with irc::string to std::string for easy assignment
 337  * and comparison - Brain
 338  */
 339 std::string operator+ (std::string& leftval, irc::string& rightval);
 340 irc::string operator+ (irc::string& leftval, std::string& rightval);
 341 bool operator== (std::string& leftval, irc::string& rightval);
 342 bool operator== (irc::string& leftval, std::string& rightval);
 343
 344 #endif