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 /* $Core */
  24
  25 #include "inspircd.h"
  26 #include "hashcomp.h"
  27
  28 /******************************************************
  29  *
  30  * The hash functions of InspIRCd are the centrepoint
  31  * of the entire system. If these functions are
  32  * inefficient or wasteful, the whole program suffers
  33  * as a result. A lot of C programmers in the ircd
  34  * scene spend a lot of time debating (arguing) about
  35  * the best way to write hash functions to hash irc
  36  * nicknames, channels etc.
  37  * We are lucky as C++ developers as unordered_map does
  38  * a lot of this for us. It does intellegent memory
  39  * requests, bucketing, search functions, insertion
  40  * and deletion etc. All we have to do is write some
  41  * overloaded comparison and hash value operators which
  42  * cause it to act in an irc-like way. The features we
  43  * add to the standard hash_map are:
  44  *
  45  * Case insensitivity: The hash_map will be case
  46  * insensitive.
  47  *
  48  * Scandanavian Comparisons: The characters [, ], \ will
  49  * be considered the lowercase of {, } and |.
  50  *
  51  ******************************************************/
  52
  53
  54 /**
  55  * A case insensitive mapping of characters from upper case to lower case for
  56  * the ASCII character set.
  57  */
  58 unsigned const char ascii_case_insensitive_map[256] = {
  59         0,   1,   2,   3,   4,   5,   6,   7,   8,   9,   // 0-9
  60         10,  11,  12,  13,  14,  15,  16,  17,  18,  19,  // 10-19
  61         20,  21,  22,  23,  24,  25,  26,  27,  28,  29,  // 20-29
  62         30,  31,  32,  33,  34,  35,  36,  37,  38,  39,  // 30-39
  63         40,  41,  42,  43,  44,  45,  46,  47,  48,  49,  // 40-49
  64         50,  51,  52,  53,  54,  55,  56,  57,  58,  59,  // 50-59
  65         60,  61,  62,  63,  64,  97,  98,  99,  100, 101, // 60-69
  66         102, 103, 104, 105, 106, 107, 108, 109, 110, 111, // 70-79
  67         112, 113, 114, 115, 116, 117, 118, 119, 120, 121, // 80-89
  68         122, 91,  92,  93,  94,  95,  96,  97,  98,  99,  // 90-99
  69         100, 101, 102, 103, 104, 105, 106, 107, 108, 109, // 100-109
  70         110, 111, 112, 113, 114, 115, 116, 117, 118, 119, // 110-119
  71         120, 121, 122, 123, 124, 125, 126, 127, 128, 129, // 120-129
  72         130, 131, 132, 133, 134, 135, 136, 137, 138, 139, // 130-139
  73         140, 141, 142, 143, 144, 145, 146, 147, 148, 149, // 140-149
  74         150, 151, 152, 153, 154, 155, 156, 157, 158, 159, // 150-159
  75         160, 161, 162, 163, 164, 165, 166, 167, 168, 169, // 160-169
  76         170, 171, 172, 173, 174, 175, 176, 177, 178, 179, // 170-179
  77         180, 181, 182, 183, 184, 185, 186, 187, 188, 189, // 180-189
  78         190, 191, 192, 193, 194, 195, 196, 197, 198, 199, // 190-199
  79         200, 201, 202, 203, 204, 205, 206, 207, 208, 209, // 200-209
  80         210, 211, 212, 213, 214, 215, 216, 217, 218, 219, // 210-219
  81         220, 221, 222, 223, 224, 225, 226, 227, 228, 229, // 220-229
  82         230, 231, 232, 233, 234, 235, 236, 237, 238, 239, // 230-249
  83         240, 241, 242, 243, 244, 245, 246, 247, 248, 249, // 240-249
  84         250, 251, 252, 253, 254, 255,                     // 250-255
  85 };
  86
  87
  88
  89 /**
  90  * A case insensitive mapping of characters from upper case to lower case for
  91  * the character set of RFC 1459. This is identical to ASCII with the small
  92  * exception of {}| being considered to be the lower case equivalents of the
  93  * characters []\ respectively.
  94  */
  95 unsigned const char rfc_case_insensitive_map[256] = {
  96         0,   1,   2,   3,   4,   5,   6,   7,   8,   9,   // 0-9
  97         10,  11,  12,  13,  14,  15,  16,  17,  18,  19,  // 10-19
  98         20,  21,  22,  23,  24,  25,  26,  27,  28,  29,  // 20-29
  99         30,  31,  32,  33,  34,  35,  36,  37,  38,  39,  // 30-39
 100         40,  41,  42,  43,  44,  45,  46,  47,  48,  49,  // 40-49
 101         50,  51,  52,  53,  54,  55,  56,  57,  58,  59,  // 50-59
 102         60,  61,  62,  63,  64,  97,  98,  99,  100, 101, // 60-69
 103         102, 103, 104, 105, 106, 107, 108, 109, 110, 111, // 70-79
 104         112, 113, 114, 115, 116, 117, 118, 119, 120, 121, // 80-89
 105         122, 123, 124, 125, 94,  95,  96,  97,  98,  99,  // 90-99
 106         100, 101, 102, 103, 104, 105, 106, 107, 108, 109, // 100-109
 107         110, 111, 112, 113, 114, 115, 116, 117, 118, 119, // 110-119
 108         120, 121, 122, 123, 124, 125, 126, 127, 128, 129, // 120-129
 109         130, 131, 132, 133, 134, 135, 136, 137, 138, 139, // 130-139
 110         140, 141, 142, 143, 144, 145, 146, 147, 148, 149, // 140-149
 111         150, 151, 152, 153, 154, 155, 156, 157, 158, 159, // 150-159
 112         160, 161, 162, 163, 164, 165, 166, 167, 168, 169, // 160-169
 113         170, 171, 172, 173, 174, 175, 176, 177, 178, 179, // 170-179
 114         180, 181, 182, 183, 184, 185, 186, 187, 188, 189, // 180-189
 115         190, 191, 192, 193, 194, 195, 196, 197, 198, 199, // 190-199
 116         200, 201, 202, 203, 204, 205, 206, 207, 208, 209, // 200-209
 117         210, 211, 212, 213, 214, 215, 216, 217, 218, 219, // 210-219
 118         220, 221, 222, 223, 224, 225, 226, 227, 228, 229, // 220-229
 119         230, 231, 232, 233, 234, 235, 236, 237, 238, 239, // 230-239
 120         240, 241, 242, 243, 244, 245, 246, 247, 248, 249, // 240-249
 121         250, 251, 252, 253, 254, 255,                     // 250-255
 122 };
 123
 124 /**
 125  * A case sensitive mapping of characters from upper case to lower case for the
 126  * character set of RFC 1459. This is identical to ASCII.
 127  */
 128 unsigned const char rfc_case_sensitive_map[256] = {
 129         0,   1,   2,   3,   4,   5,   6,   7,   8,   9,   // 0-9
 130         10,  11,  12,  13,  14,  15,  16,  17,  18,  19,  // 10-19
 131         20,  21,  22,  23,  24,  25,  26,  27,  28,  29,  // 20-29
 132         30,  31,  32,  33,  34,  35,  36,  37,  38,  39,  // 30-39
 133         40,  41,  42,  43,  44,  45,  46,  47,  48,  49,  // 40-49
 134         50,  51,  52,  53,  54,  55,  56,  57,  58,  59,  // 50-59
 135         60,  61,  62,  63,  64,  65,  66,  67,  68,  69,  // 60-69
 136         70,  71,  72,  73,  74,  75,  76,  77,  78,  79,  // 70-79
 137         80,  81,  82,  83,  84,  85,  86,  87,  88,  89,  // 80-89
 138         90,  91,  92,  93,  94,  95,  96,  97,  98,  99,  // 90-99
 139         100, 101, 102, 103, 104, 105, 106, 107, 108, 109, // 100-109
 140         110, 111, 112, 113, 114, 115, 116, 117, 118, 119, // 110-119
 141         120, 121, 122, 123, 124, 125, 126, 127, 128, 129, // 120-129
 142         130, 131, 132, 133, 134, 135, 136, 137, 138, 139, // 130-139
 143         140, 141, 142, 143, 144, 145, 146, 147, 148, 149, // 140-149
 144         150, 151, 152, 153, 154, 155, 156, 157, 158, 159, // 150-159
 145         160, 161, 162, 163, 164, 165, 166, 167, 168, 169, // 160-169
 146         170, 171, 172, 173, 174, 175, 176, 177, 178, 179, // 170-179
 147         180, 181, 182, 183, 184, 185, 186, 187, 188, 189, // 180-189
 148         190, 191, 192, 193, 194, 195, 196, 197, 198, 199, // 190-199
 149         200, 201, 202, 203, 204, 205, 206, 207, 208, 209, // 200-209
 150         210, 211, 212, 213, 214, 215, 216, 217, 218, 219, // 210-219
 151         220, 221, 222, 223, 224, 225, 226, 227, 228, 229, // 220-229
 152         230, 231, 232, 233, 234, 235, 236, 237, 238, 239, // 230-239
 153         240, 241, 242, 243, 244, 245, 246, 247, 248, 249, // 240-249
 154         250, 251, 252, 253, 254, 255,                     // 250-255
 155 };
 156
 157 size_t CoreExport irc::hash::operator()(const irc::string &s) const
 158 {
 159         register size_t t = 0;
 160         for (irc::string::const_iterator x = s.begin(); x != s.end(); ++x) /* ++x not x++, as its faster */
 161                 t = 5 * t + national_case_insensitive_map[(unsigned char)*x];
 162         return t;
 163 }
 164
 165 bool irc::StrHashComp::operator()(const std::string& s1, const std::string& s2) const
 166 {
 167         const unsigned char* n1 = (const unsigned char*)s1.c_str();
 168         const unsigned char* n2 = (const unsigned char*)s2.c_str();
 169         for (; *n1 && *n2; n1++, n2++)
 170                 if (national_case_insensitive_map[*n1] != national_case_insensitive_map[*n2])
 171                         return false;
 172         return (national_case_insensitive_map[*n1] == national_case_insensitive_map[*n2]);
 173 }
 174
 175 size_t irc::insensitive::operator()(const std::string &s) const
 176 {
 177         /* XXX: NO DATA COPIES! :)
 178          * The hash function here is practically
 179          * a copy of the one in STL's hash_fun.h,
 180          * only with *x replaced with national_case_insensitive_map[*x].
 181          * This avoids a copy to use hash<const char*>
 182          */
 183         register size_t t = 0;
 184         for (std::string::const_iterator x = s.begin(); x != s.end(); ++x) /* ++x not x++, as its faster */
 185                 t = 5 * t + national_case_insensitive_map[(unsigned char)*x];
 186         return t;
 187 }
 188
 189 /******************************************************
 190  *
 191  * This is the implementation of our special irc::string
 192  * class which is a case-insensitive equivalent to
 193  * std::string which is not only case-insensitive but
 194  * can also do scandanavian comparisons, e.g. { = [, etc.
 195  *
 196  * This class depends on the const array 'national_case_insensitive_map'.
 197  *
 198  ******************************************************/
 199
 200 bool irc::irc_char_traits::eq(char c1st, char c2nd)
 201 {
 202         return national_case_insensitive_map[(unsigned char)c1st] == national_case_insensitive_map[(unsigned char)c2nd];
 203 }
 204
 205 bool irc::irc_char_traits::ne(char c1st, char c2nd)
 206 {
 207         return national_case_insensitive_map[(unsigned char)c1st] != national_case_insensitive_map[(unsigned char)c2nd];
 208 }
 209
 210 bool irc::irc_char_traits::lt(char c1st, char c2nd)
 211 {
 212         return national_case_insensitive_map[(unsigned char)c1st] < national_case_insensitive_map[(unsigned char)c2nd];
 213 }
 214
 215 int irc::irc_char_traits::compare(const char* str1, const char* str2, size_t n)
 216 {
 217         for(unsigned int i = 0; i < n; i++)
 218         {
 219                 if(national_case_insensitive_map[(unsigned char)*str1] > national_case_insensitive_map[(unsigned char)*str2])
 220                         return 1;
 221
 222                 if(national_case_insensitive_map[(unsigned char)*str1] < national_case_insensitive_map[(unsigned char)*str2])
 223                         return -1;
 224
 225                 if(*str1 == 0 || *str2 == 0)
 226                         return 0;
 227
 228                 str1++;
 229                 str2++;
 230         }
 231         return 0;
 232 }
 233
 234 const char* irc::irc_char_traits::find(const char* s1, int  n, char c)
 235 {
 236         while(n-- > 0 && national_case_insensitive_map[(unsigned char)*s1] != national_case_insensitive_map[(unsigned char)c])
 237                 s1++;
 238         return (n >= 0) ? s1 : NULL;
 239 }
 240
 241 irc::tokenstream::tokenstream(const std::string &source) : tokens(source), last_pushed(false)
 242 {
 243         /* Record starting position and current position */
 244         last_starting_position = tokens.begin();
 245         n = tokens.begin();
 246 }
 247
 248 bool irc::tokenstream::GetToken(std::string &token)
 249 {
 250         std::string::iterator lsp = last_starting_position;
 251
 252         while (n != tokens.end())
 253         {
 254                 /** Skip multi space, converting "  " into " "
 255                  */
 256                 while ((n+1 != tokens.end()) && (*n == ' ') && (*(n+1) == ' '))
 257                         n++;
 258
 259                 if ((last_pushed) && (*n == ':'))
 260                 {
 261                         /* If we find a token thats not the first and starts with :,
 262                          * this is the last token on the line
 263                          */
 264                         std::string::iterator curr = ++n;
 265                         n = tokens.end();
 266                         token = std::string(curr, tokens.end());
 267                         return true;
 268                 }
 269
 270                 last_pushed = false;
 271
 272                 if ((*n == ' ') || (n+1 == tokens.end()))
 273                 {
 274                         /* If we find a space, or end of string, this is the end of a token.
 275                          */
 276                         last_starting_position = n+1;
 277                         last_pushed = *n == ' ';
 278
 279                         std::string strip(lsp, n+1 == tokens.end() ? n+1  : n++);
 280                         while ((strip.length()) && (strip.find_last_of(' ') == strip.length() - 1))
 281                                 strip.erase(strip.end() - 1);
 282
 283                         token = strip;
 284                         return !token.empty();
 285                 }
 286
 287                 n++;
 288         }
 289         token.clear();
 290         return false;
 291 }
 292
 293 bool irc::tokenstream::GetToken(irc::string &token)
 294 {
 295         std::string stdstring;
 296         bool returnval = GetToken(stdstring);
 297         token = assign(stdstring);
 298         return returnval;
 299 }
 300
 301 bool irc::tokenstream::GetToken(int &token)
 302 {
 303         std::string tok;
 304         bool returnval = GetToken(tok);
 305         token = ConvToInt(tok);
 306         return returnval;
 307 }
 308
 309 bool irc::tokenstream::GetToken(long &token)
 310 {
 311         std::string tok;
 312         bool returnval = GetToken(tok);
 313         token = ConvToInt(tok);
 314         return returnval;
 315 }
 316
 317 irc::sepstream::sepstream(const std::string &source, char seperator) : tokens(source), sep(seperator)
 318 {
 319         last_starting_position = tokens.begin();
 320         n = tokens.begin();
 321 }
 322
 323 bool irc::sepstream::GetToken(std::string &token)
 324 {
 325         std::string::iterator lsp = last_starting_position;
 326
 327         while (n != tokens.end())
 328         {
 329                 if ((*n == sep) || (n+1 == tokens.end()))
 330                 {
 331                         last_starting_position = n+1;
 332                         token = std::string(lsp, n+1 == tokens.end() ? n+1  : n++);
 333
 334                         while ((token.length()) && (token.find_last_of(sep) == token.length() - 1))
 335                                 token.erase(token.end() - 1);
 336
 337                         if (token.empty())
 338                                 n++;
 339
 340                         return n == tokens.end() ? false : true;
 341                 }
 342
 343                 n++;
 344         }
 345
 346         token.clear();
 347         return false;
 348 }
 349
 350 const std::string irc::sepstream::GetRemaining()
 351 {
 352         return std::string(n, tokens.end());
 353 }
 354
 355 bool irc::sepstream::StreamEnd()
 356 {
 357         return ((n + 1) == tokens.end());
 358 }
 359
 360 irc::modestacker::modestacker(bool add) : adding(add)
 361 {
 362         sequence.clear();
 363         sequence.push_back("");
 364 }
 365
 366 void irc::modestacker::Push(char modeletter, const std::string &parameter)
 367 {
 368         *(sequence.begin()) += modeletter;
 369         sequence.push_back(parameter);
 370 }
 371
 372 void irc::modestacker::Push(char modeletter)
 373 {
 374         this->Push(modeletter,"");
 375 }
 376
 377 void irc::modestacker::PushPlus()
 378 {
 379         this->Push('+',"");
 380 }
 381
 382 void irc::modestacker::PushMinus()
 383 {
 384         this->Push('-',"");
 385 }
 386
 387 int irc::modestacker::GetStackedLine(std::vector<std::string> &result, int max_line_size)
 388 {
 389         if (sequence.empty())
 390         {
 391                 return 0;
 392         }
 393
 394         unsigned int n = 0;
 395         int size = 1; /* Account for initial +/- char */
 396         int nextsize = 0;
 397         int start = result.size();
 398         std::string modeline = adding ? "+" : "-";
 399         result.push_back(modeline);
 400
 401         if (sequence.size() > 1)
 402                 nextsize = sequence[1].length() + 2;
 403
 404         while (!sequence[0].empty() && (sequence.size() > 1) && (n < ServerInstance->Config->Limits.MaxModes) && ((size + nextsize) < max_line_size))
 405         {
 406                 modeline += *(sequence[0].begin());
 407                 if (!sequence[1].empty())
 408                 {
 409                         result.push_back(sequence[1]);
 410                         size += nextsize; /* Account for mode character and whitespace */
 411                 }
 412                 sequence[0].erase(sequence[0].begin());
 413                 sequence.erase(sequence.begin() + 1);
 414
 415                 if (sequence.size() > 1)
 416                         nextsize = sequence[1].length() + 2;
 417
 418                 n++;
 419         }
 420         result[start] = modeline;
 421
 422         return n;
 423 }
 424
 425 irc::stringjoiner::stringjoiner(const std::string& seperator, const std::vector<std::string>& sequence, unsigned int begin, unsigned int end)
 426 {
 427         if (end < begin)
 428                 return; // nothing to do here
 429
 430         for (unsigned int v = begin; v < end; v++)
 431                 joined.append(sequence[v]).append(seperator);
 432         joined.append(sequence[end]);
 433 }
 434
 435 irc::portparser::portparser(const std::string &source, bool allow_overlapped)
 436         : sep(source), in_range(0), range_begin(0), range_end(0), overlapped(allow_overlapped)
 437 {
 438 }
 439
 440 bool irc::portparser::Overlaps(long val)
 441 {
 442         if (overlapped)
 443                 return false;
 444
 445         return (!overlap_set.insert(val).second);
 446 }
 447
 448 long irc::portparser::GetToken()
 449 {
 450         if (in_range > 0)
 451         {
 452                 in_range++;
 453                 if (in_range <= range_end)
 454                 {
 455                         if (!Overlaps(in_range))
 456                         {
 457                                 return in_range;
 458                         }
 459                         else
 460                         {
 461                                 while (((Overlaps(in_range)) && (in_range <= range_end)))
 462                                         in_range++;
 463
 464                                 if (in_range <= range_end)
 465                                         return in_range;
 466                         }
 467                 }
 468                 else
 469                         in_range = 0;
 470         }
 471
 472         std::string x;
 473         sep.GetToken(x);
 474
 475         if (x.empty())
 476                 return 0;
 477
 478         while (Overlaps(atoi(x.c_str())))
 479         {
 480                 if (!sep.GetToken(x))
 481                         return 0;
 482         }
 483
 484         std::string::size_type dash = x.rfind('-');
 485         if (dash != std::string::npos)
 486         {
 487                 std::string sbegin = x.substr(0, dash);
 488                 std::string send = x.substr(dash+1, x.length());
 489                 range_begin = atoi(sbegin.c_str());
 490                 range_end = atoi(send.c_str());
 491
 492                 if ((range_begin > 0) && (range_end > 0) && (range_begin < 65536) && (range_end < 65536) && (range_begin < range_end))
 493                 {
 494                         in_range = range_begin;
 495                         return in_range;
 496                 }
 497                 else
 498                 {
 499                         /* Assume its just the one port */
 500                         return atoi(sbegin.c_str());
 501                 }
 502         }
 503         else
 504         {
 505                 return atoi(x.c_str());
 506         }
 507 }