src/hashcomp.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2005-2009 Craig Edwards <craigedwards@brainbox.cc>
   6  *   Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
   7  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
   8  *
   9  * This file is part of InspIRCd.  InspIRCd is free software: you can
  10  * redistribute it and/or modify it under the terms of the GNU General Public
  11  * License as published by the Free Software Foundation, version 2.
  12  *
  13  * This program is distributed in the hope that it will be useful, but WITHOUT
  14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  15  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  16  * details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22
  23 #include "inspircd.h"
  24
  25 /******************************************************
  26  *
  27  * The hash functions of InspIRCd are the centrepoint
  28  * of the entire system. If these functions are
  29  * inefficient or wasteful, the whole program suffers
  30  * as a result. A lot of C programmers in the ircd
  31  * scene spend a lot of time debating (arguing) about
  32  * the best way to write hash functions to hash irc
  33  * nicknames, channels etc.
  34  * We are lucky as C++ developers as unordered_map does
  35  * a lot of this for us. It does intellegent memory
  36  * requests, bucketing, search functions, insertion
  37  * and deletion etc. All we have to do is write some
  38  * overloaded comparison and hash value operators which
  39  * cause it to act in an irc-like way. The features we
  40  * add to the standard hash_map are:
  41  *
  42  * Case insensitivity: The hash_map will be case
  43  * insensitive.
  44  *
  45  * Scandanavian Comparisons: The characters [, ], \ will
  46  * be considered the lowercase of {, } and |.
  47  *
  48  ******************************************************/
  49
  50
  51 /**
  52  * A case insensitive mapping of characters from upper case to lower case for
  53  * the ASCII character set.
  54  */
  55 unsigned const char ascii_case_insensitive_map[256] = {
  56         0,   1,   2,   3,   4,   5,   6,   7,   8,   9,   // 0-9
  57         10,  11,  12,  13,  14,  15,  16,  17,  18,  19,  // 10-19
  58         20,  21,  22,  23,  24,  25,  26,  27,  28,  29,  // 20-29
  59         30,  31,  32,  33,  34,  35,  36,  37,  38,  39,  // 30-39
  60         40,  41,  42,  43,  44,  45,  46,  47,  48,  49,  // 40-49
  61         50,  51,  52,  53,  54,  55,  56,  57,  58,  59,  // 50-59
  62         60,  61,  62,  63,  64,  97,  98,  99,  100, 101, // 60-69
  63         102, 103, 104, 105, 106, 107, 108, 109, 110, 111, // 70-79
  64         112, 113, 114, 115, 116, 117, 118, 119, 120, 121, // 80-89
  65         122, 91,  92,  93,  94,  95,  96,  97,  98,  99,  // 90-99
  66         100, 101, 102, 103, 104, 105, 106, 107, 108, 109, // 100-109
  67         110, 111, 112, 113, 114, 115, 116, 117, 118, 119, // 110-119
  68         120, 121, 122, 123, 124, 125, 126, 127, 128, 129, // 120-129
  69         130, 131, 132, 133, 134, 135, 136, 137, 138, 139, // 130-139
  70         140, 141, 142, 143, 144, 145, 146, 147, 148, 149, // 140-149
  71         150, 151, 152, 153, 154, 155, 156, 157, 158, 159, // 150-159
  72         160, 161, 162, 163, 164, 165, 166, 167, 168, 169, // 160-169
  73         170, 171, 172, 173, 174, 175, 176, 177, 178, 179, // 170-179
  74         180, 181, 182, 183, 184, 185, 186, 187, 188, 189, // 180-189
  75         190, 191, 192, 193, 194, 195, 196, 197, 198, 199, // 190-199
  76         200, 201, 202, 203, 204, 205, 206, 207, 208, 209, // 200-209
  77         210, 211, 212, 213, 214, 215, 216, 217, 218, 219, // 210-219
  78         220, 221, 222, 223, 224, 225, 226, 227, 228, 229, // 220-229
  79         230, 231, 232, 233, 234, 235, 236, 237, 238, 239, // 230-249
  80         240, 241, 242, 243, 244, 245, 246, 247, 248, 249, // 240-249
  81         250, 251, 252, 253, 254, 255,                     // 250-255
  82 };
  83
  84
  85
  86 /**
  87  * A case insensitive mapping of characters from upper case to lower case for
  88  * the character set of RFC 1459. This is identical to ASCII with the small
  89  * exception of {}| being considered to be the lower case equivalents of the
  90  * characters []\ respectively.
  91  */
  92 unsigned const char rfc_case_insensitive_map[256] = {
  93         0,   1,   2,   3,   4,   5,   6,   7,   8,   9,   // 0-9
  94         10,  11,  12,  13,  14,  15,  16,  17,  18,  19,  // 10-19
  95         20,  21,  22,  23,  24,  25,  26,  27,  28,  29,  // 20-29
  96         30,  31,  32,  33,  34,  35,  36,  37,  38,  39,  // 30-39
  97         40,  41,  42,  43,  44,  45,  46,  47,  48,  49,  // 40-49
  98         50,  51,  52,  53,  54,  55,  56,  57,  58,  59,  // 50-59
  99         60,  61,  62,  63,  64,  97,  98,  99,  100, 101, // 60-69
 100         102, 103, 104, 105, 106, 107, 108, 109, 110, 111, // 70-79
 101         112, 113, 114, 115, 116, 117, 118, 119, 120, 121, // 80-89
 102         122, 123, 124, 125, 94,  95,  96,  97,  98,  99,  // 90-99
 103         100, 101, 102, 103, 104, 105, 106, 107, 108, 109, // 100-109
 104         110, 111, 112, 113, 114, 115, 116, 117, 118, 119, // 110-119
 105         120, 121, 122, 123, 124, 125, 126, 127, 128, 129, // 120-129
 106         130, 131, 132, 133, 134, 135, 136, 137, 138, 139, // 130-139
 107         140, 141, 142, 143, 144, 145, 146, 147, 148, 149, // 140-149
 108         150, 151, 152, 153, 154, 155, 156, 157, 158, 159, // 150-159
 109         160, 161, 162, 163, 164, 165, 166, 167, 168, 169, // 160-169
 110         170, 171, 172, 173, 174, 175, 176, 177, 178, 179, // 170-179
 111         180, 181, 182, 183, 184, 185, 186, 187, 188, 189, // 180-189
 112         190, 191, 192, 193, 194, 195, 196, 197, 198, 199, // 190-199
 113         200, 201, 202, 203, 204, 205, 206, 207, 208, 209, // 200-209
 114         210, 211, 212, 213, 214, 215, 216, 217, 218, 219, // 210-219
 115         220, 221, 222, 223, 224, 225, 226, 227, 228, 229, // 220-229
 116         230, 231, 232, 233, 234, 235, 236, 237, 238, 239, // 230-239
 117         240, 241, 242, 243, 244, 245, 246, 247, 248, 249, // 240-249
 118         250, 251, 252, 253, 254, 255,                     // 250-255
 119 };
 120
 121 /**
 122  * A case sensitive mapping of characters from upper case to lower case for the
 123  * character set of RFC 1459. This is identical to ASCII.
 124  */
 125 unsigned const char rfc_case_sensitive_map[256] = {
 126         0,   1,   2,   3,   4,   5,   6,   7,   8,   9,   // 0-9
 127         10,  11,  12,  13,  14,  15,  16,  17,  18,  19,  // 10-19
 128         20,  21,  22,  23,  24,  25,  26,  27,  28,  29,  // 20-29
 129         30,  31,  32,  33,  34,  35,  36,  37,  38,  39,  // 30-39
 130         40,  41,  42,  43,  44,  45,  46,  47,  48,  49,  // 40-49
 131         50,  51,  52,  53,  54,  55,  56,  57,  58,  59,  // 50-59
 132         60,  61,  62,  63,  64,  65,  66,  67,  68,  69,  // 60-69
 133         70,  71,  72,  73,  74,  75,  76,  77,  78,  79,  // 70-79
 134         80,  81,  82,  83,  84,  85,  86,  87,  88,  89,  // 80-89
 135         90,  91,  92,  93,  94,  95,  96,  97,  98,  99,  // 90-99
 136         100, 101, 102, 103, 104, 105, 106, 107, 108, 109, // 100-109
 137         110, 111, 112, 113, 114, 115, 116, 117, 118, 119, // 110-119
 138         120, 121, 122, 123, 124, 125, 126, 127, 128, 129, // 120-129
 139         130, 131, 132, 133, 134, 135, 136, 137, 138, 139, // 130-139
 140         140, 141, 142, 143, 144, 145, 146, 147, 148, 149, // 140-149
 141         150, 151, 152, 153, 154, 155, 156, 157, 158, 159, // 150-159
 142         160, 161, 162, 163, 164, 165, 166, 167, 168, 169, // 160-169
 143         170, 171, 172, 173, 174, 175, 176, 177, 178, 179, // 170-179
 144         180, 181, 182, 183, 184, 185, 186, 187, 188, 189, // 180-189
 145         190, 191, 192, 193, 194, 195, 196, 197, 198, 199, // 190-199
 146         200, 201, 202, 203, 204, 205, 206, 207, 208, 209, // 200-209
 147         210, 211, 212, 213, 214, 215, 216, 217, 218, 219, // 210-219
 148         220, 221, 222, 223, 224, 225, 226, 227, 228, 229, // 220-229
 149         230, 231, 232, 233, 234, 235, 236, 237, 238, 239, // 230-239
 150         240, 241, 242, 243, 244, 245, 246, 247, 248, 249, // 240-249
 151         250, 251, 252, 253, 254, 255,                     // 250-255
 152 };
 153
 154 bool irc::StrHashComp::operator()(const std::string& s1, const std::string& s2) const
 155 {
 156         const unsigned char* n1 = (const unsigned char*)s1.c_str();
 157         const unsigned char* n2 = (const unsigned char*)s2.c_str();
 158         for (; *n1 && *n2; n1++, n2++)
 159                 if (national_case_insensitive_map[*n1] != national_case_insensitive_map[*n2])
 160                         return false;
 161         return (national_case_insensitive_map[*n1] == national_case_insensitive_map[*n2]);
 162 }
 163
 164 bool irc::insensitive_swo::operator()(const std::string& a, const std::string& b) const
 165 {
 166         const unsigned char* charmap = national_case_insensitive_map;
 167         std::string::size_type asize = a.size();
 168         std::string::size_type bsize = b.size();
 169         std::string::size_type maxsize = std::min(asize, bsize);
 170
 171         for (std::string::size_type i = 0; i < maxsize; i++)
 172         {
 173                 unsigned char A = charmap[(unsigned char)a[i]];
 174                 unsigned char B = charmap[(unsigned char)b[i]];
 175                 if (A > B)
 176                         return false;
 177                 else if (A < B)
 178                         return true;
 179         }
 180         return (asize < bsize);
 181 }
 182
 183 size_t irc::insensitive::operator()(const std::string &s) const
 184 {
 185         /* XXX: NO DATA COPIES! :)
 186          * The hash function here is practically
 187          * a copy of the one in STL's hash_fun.h,
 188          * only with *x replaced with national_case_insensitive_map[*x].
 189          * This avoids a copy to use hash<const char*>
 190          */
 191         size_t t = 0;
 192         for (std::string::const_iterator x = s.begin(); x != s.end(); ++x) /* ++x not x++, as its faster */
 193                 t = 5 * t + national_case_insensitive_map[(unsigned char)*x];
 194         return t;
 195 }
 196
 197 /******************************************************
 198  *
 199  * This is the implementation of our special irc::string
 200  * class which is a case-insensitive equivalent to
 201  * std::string which is not only case-insensitive but
 202  * can also do scandanavian comparisons, e.g. { = [, etc.
 203  *
 204  * This class depends on the const array 'national_case_insensitive_map'.
 205  *
 206  ******************************************************/
 207
 208 bool irc::irc_char_traits::eq(char c1st, char c2nd)
 209 {
 210         return national_case_insensitive_map[(unsigned char)c1st] == national_case_insensitive_map[(unsigned char)c2nd];
 211 }
 212
 213 bool irc::irc_char_traits::ne(char c1st, char c2nd)
 214 {
 215         return national_case_insensitive_map[(unsigned char)c1st] != national_case_insensitive_map[(unsigned char)c2nd];
 216 }
 217
 218 bool irc::irc_char_traits::lt(char c1st, char c2nd)
 219 {
 220         return national_case_insensitive_map[(unsigned char)c1st] < national_case_insensitive_map[(unsigned char)c2nd];
 221 }
 222
 223 int irc::irc_char_traits::compare(const char* str1, const char* str2, size_t n)
 224 {
 225         for(unsigned int i = 0; i < n; i++)
 226         {
 227                 if(national_case_insensitive_map[(unsigned char)*str1] > national_case_insensitive_map[(unsigned char)*str2])
 228                         return 1;
 229
 230                 if(national_case_insensitive_map[(unsigned char)*str1] < national_case_insensitive_map[(unsigned char)*str2])
 231                         return -1;
 232
 233                 if(*str1 == 0 || *str2 == 0)
 234                         return 0;
 235
 236                 str1++;
 237                 str2++;
 238         }
 239         return 0;
 240 }
 241
 242 const char* irc::irc_char_traits::find(const char* s1, int  n, char c)
 243 {
 244         while(n-- > 0 && national_case_insensitive_map[(unsigned char)*s1] != national_case_insensitive_map[(unsigned char)c])
 245                 s1++;
 246         return (n >= 0) ? s1 : NULL;
 247 }
 248
 249 irc::tokenstream::tokenstream(const std::string &source) : spacesepstream(source)
 250 {
 251 }
 252
 253 bool irc::tokenstream::GetToken(std::string &token)
 254 {
 255         bool first = !pos;
 256
 257         if (!spacesepstream::GetToken(token))
 258                 return false;
 259
 260         /* This is the last parameter */
 261         if (token[0] == ':' && !first)
 262         {
 263                 token.erase(token.begin());
 264                 if (!StreamEnd())
 265                 {
 266                         token += ' ';
 267                         token += GetRemaining();
 268                 }
 269                 pos = tokens.length() + 1;
 270         }
 271
 272         return true;
 273 }
 274
 275 bool irc::tokenstream::GetToken(irc::string &token)
 276 {
 277         std::string stdstring;
 278         bool returnval = GetToken(stdstring);
 279         token = assign(stdstring);
 280         return returnval;
 281 }
 282
 283 bool irc::tokenstream::GetToken(int &token)
 284 {
 285         std::string tok;
 286         bool returnval = GetToken(tok);
 287         token = ConvToInt(tok);
 288         return returnval;
 289 }
 290
 291 bool irc::tokenstream::GetToken(long &token)
 292 {
 293         std::string tok;
 294         bool returnval = GetToken(tok);
 295         token = ConvToInt(tok);
 296         return returnval;
 297 }
 298
 299 irc::sepstream::sepstream(const std::string& source, char separator, bool allowempty)
 300         : tokens(source), sep(separator), pos(0), allow_empty(allowempty)
 301 {
 302 }
 303
 304 bool irc::sepstream::GetToken(std::string &token)
 305 {
 306         if (this->StreamEnd())
 307         {
 308                 token.clear();
 309                 return false;
 310         }
 311
 312         if (!this->allow_empty)
 313         {
 314                 this->pos = this->tokens.find_first_not_of(this->sep, this->pos);
 315                 if (this->pos == std::string::npos)
 316                 {
 317                         this->pos = this->tokens.length() + 1;
 318                         token.clear();
 319                         return false;
 320                 }
 321         }
 322
 323         size_t p = this->tokens.find(this->sep, this->pos);
 324         if (p == std::string::npos)
 325                 p = this->tokens.length();
 326
 327         token.assign(tokens, this->pos, p - this->pos);
 328         this->pos = p + 1;
 329
 330         return true;
 331 }
 332
 333 const std::string irc::sepstream::GetRemaining()
 334 {
 335         return !this->StreamEnd() ? this->tokens.substr(this->pos) : "";
 336 }
 337
 338 bool irc::sepstream::StreamEnd()
 339 {
 340         return this->pos > this->tokens.length();
 341 }
 342
 343 std::string irc::stringjoiner(const std::vector<std::string>& sequence, char separator)
 344 {
 345         std::string joined;
 346         if (sequence.empty())
 347                 return joined; // nothing to do here
 348
 349         for (std::vector<std::string>::const_iterator i = sequence.begin(); i != sequence.end(); ++i)
 350                 joined.append(*i).push_back(separator);
 351         joined.erase(joined.end()-1);
 352         return joined;
 353 }
 354
 355 irc::portparser::portparser(const std::string &source, bool allow_overlapped)
 356         : sep(source), in_range(0), range_begin(0), range_end(0), overlapped(allow_overlapped)
 357 {
 358 }
 359
 360 bool irc::portparser::Overlaps(long val)
 361 {
 362         if (overlapped)
 363                 return false;
 364
 365         return (!overlap_set.insert(val).second);
 366 }
 367
 368 long irc::portparser::GetToken()
 369 {
 370         if (in_range > 0)
 371         {
 372                 in_range++;
 373                 if (in_range <= range_end)
 374                 {
 375                         if (!Overlaps(in_range))
 376                         {
 377                                 return in_range;
 378                         }
 379                         else
 380                         {
 381                                 while (((Overlaps(in_range)) && (in_range <= range_end)))
 382                                         in_range++;
 383
 384                                 if (in_range <= range_end)
 385                                         return in_range;
 386                         }
 387                 }
 388                 else
 389                         in_range = 0;
 390         }
 391
 392         std::string x;
 393         sep.GetToken(x);
 394
 395         if (x.empty())
 396                 return 0;
 397
 398         while (Overlaps(atoi(x.c_str())))
 399         {
 400                 if (!sep.GetToken(x))
 401                         return 0;
 402         }
 403
 404         std::string::size_type dash = x.rfind('-');
 405         if (dash != std::string::npos)
 406         {
 407                 std::string sbegin(x, 0, dash);
 408                 range_begin = atoi(sbegin.c_str());
 409                 range_end = atoi(x.c_str()+dash+1);
 410
 411                 if ((range_begin > 0) && (range_end > 0) && (range_begin < 65536) && (range_end < 65536) && (range_begin < range_end))
 412                 {
 413                         in_range = range_begin;
 414                         return in_range;
 415                 }
 416                 else
 417                 {
 418                         /* Assume its just the one port */
 419                         return atoi(sbegin.c_str());
 420                 }
 421         }
 422         else
 423         {
 424                 return atoi(x.c_str());
 425         }
 426 }