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 irc::tokenstream::~tokenstream()
 249 {
 250 }
 251
 252 bool irc::tokenstream::GetToken(std::string &token)
 253 {
 254         std::string::iterator lsp = last_starting_position;
 255
 256         while (n != tokens.end())
 257         {
 258                 /** Skip multi space, converting "  " into " "
 259                  */
 260                 while ((n+1 != tokens.end()) && (*n == ' ') && (*(n+1) == ' '))
 261                         n++;
 262
 263                 if ((last_pushed) && (*n == ':'))
 264                 {
 265                         /* If we find a token thats not the first and starts with :,
 266                          * this is the last token on the line
 267                          */
 268                         std::string::iterator curr = ++n;
 269                         n = tokens.end();
 270                         token = std::string(curr, tokens.end());
 271                         return true;
 272                 }
 273
 274                 last_pushed = false;
 275
 276                 if ((*n == ' ') || (n+1 == tokens.end()))
 277                 {
 278                         /* If we find a space, or end of string, this is the end of a token.
 279                          */
 280                         last_starting_position = n+1;
 281                         last_pushed = *n == ' ';
 282
 283                         std::string strip(lsp, n+1 == tokens.end() ? n+1  : n++);
 284                         while ((strip.length()) && (strip.find_last_of(' ') == strip.length() - 1))
 285                                 strip.erase(strip.end() - 1);
 286
 287                         token = strip;
 288                         return !token.empty();
 289                 }
 290
 291                 n++;
 292         }
 293         token.clear();
 294         return false;
 295 }
 296
 297 bool irc::tokenstream::GetToken(irc::string &token)
 298 {
 299         std::string stdstring;
 300         bool returnval = GetToken(stdstring);
 301         token = assign(stdstring);
 302         return returnval;
 303 }
 304
 305 bool irc::tokenstream::GetToken(int &token)
 306 {
 307         std::string tok;
 308         bool returnval = GetToken(tok);
 309         token = ConvToInt(tok);
 310         return returnval;
 311 }
 312
 313 bool irc::tokenstream::GetToken(long &token)
 314 {
 315         std::string tok;
 316         bool returnval = GetToken(tok);
 317         token = ConvToInt(tok);
 318         return returnval;
 319 }
 320
 321 irc::sepstream::sepstream(const std::string &source, char seperator) : tokens(source), sep(seperator)
 322 {
 323         last_starting_position = tokens.begin();
 324         n = tokens.begin();
 325 }
 326
 327 bool irc::sepstream::GetToken(std::string &token)
 328 {
 329         std::string::iterator lsp = last_starting_position;
 330
 331         while (n != tokens.end())
 332         {
 333                 if ((*n == sep) || (n+1 == tokens.end()))
 334                 {
 335                         last_starting_position = n+1;
 336                         token = std::string(lsp, n+1 == tokens.end() ? n+1  : n++);
 337
 338                         while ((token.length()) && (token.find_last_of(sep) == token.length() - 1))
 339                                 token.erase(token.end() - 1);
 340
 341                         if (token.empty())
 342                                 n++;
 343
 344                         return n == tokens.end() ? false : true;
 345                 }
 346
 347                 n++;
 348         }
 349
 350         token.clear();
 351         return false;
 352 }
 353
 354 const std::string irc::sepstream::GetRemaining()
 355 {
 356         return std::string(n, tokens.end());
 357 }
 358
 359 bool irc::sepstream::StreamEnd()
 360 {
 361         return ((n + 1) == tokens.end());
 362 }
 363
 364 irc::sepstream::~sepstream()
 365 {
 366 }
 367
 368 std::string irc::hex(const unsigned char *raw, size_t rawsz)
 369 {
 370         if (!rawsz)
 371                 return "";
 372
 373         /* EWW! This used to be using sprintf, which is WAY inefficient. -Special */
 374
 375         const char *hex = "0123456789abcdef";
 376         static char hexbuf[MAXBUF];
 377
 378         size_t i, j;
 379         for (i = 0, j = 0; j < rawsz; ++j)
 380         {
 381                 hexbuf[i++] = hex[raw[j] / 16];
 382                 hexbuf[i++] = hex[raw[j] % 16];
 383         }
 384         hexbuf[i] = 0;
 385
 386         return hexbuf;
 387 }
 388
 389 CoreExport const char* irc::Spacify(const char* n)
 390 {
 391         static char x[MAXBUF];
 392         strlcpy(x,n,MAXBUF);
 393         for (char* y = x; *y; y++)
 394                 if (*y == '_')
 395                         *y = ' ';
 396         return x;
 397 }
 398
 399
 400 irc::modestacker::modestacker(bool add) : adding(add)
 401 {
 402         sequence.clear();
 403         sequence.push_back("");
 404 }
 405
 406 void irc::modestacker::Push(char modeletter, const std::string &parameter)
 407 {
 408         *(sequence.begin()) += modeletter;
 409         sequence.push_back(parameter);
 410 }
 411
 412 void irc::modestacker::Push(char modeletter)
 413 {
 414         this->Push(modeletter,"");
 415 }
 416
 417 void irc::modestacker::PushPlus()
 418 {
 419         this->Push('+',"");
 420 }
 421
 422 void irc::modestacker::PushMinus()
 423 {
 424         this->Push('-',"");
 425 }
 426
 427 int irc::modestacker::GetStackedLine(std::vector<std::string> &result, int max_line_size)
 428 {
 429         if (sequence.empty())
 430         {
 431                 return 0;
 432         }
 433
 434         unsigned int n = 0;
 435         int size = 1; /* Account for initial +/- char */
 436         int nextsize = 0;
 437         int start = result.size();
 438         std::string modeline = adding ? "+" : "-";
 439         result.push_back(modeline);
 440
 441         if (sequence.size() > 1)
 442                 nextsize = sequence[1].length() + 2;
 443
 444         while (!sequence[0].empty() && (sequence.size() > 1) && (n < ServerInstance->Config->Limits.MaxModes) && ((size + nextsize) < max_line_size))
 445         {
 446                 modeline += *(sequence[0].begin());
 447                 if (!sequence[1].empty())
 448                 {
 449                         result.push_back(sequence[1]);
 450                         size += nextsize; /* Account for mode character and whitespace */
 451                 }
 452                 sequence[0].erase(sequence[0].begin());
 453                 sequence.erase(sequence.begin() + 1);
 454
 455                 if (sequence.size() > 1)
 456                         nextsize = sequence[1].length() + 2;
 457
 458                 n++;
 459         }
 460         result[start] = modeline;
 461
 462         return n;
 463 }
 464
 465 irc::stringjoiner::stringjoiner(const std::string &seperator, const std::vector<std::string> &sequence, int begin, int end)
 466 {
 467         if (end < begin)
 468                 return; // nothing to do here
 469
 470         for (int v = begin; v < end; v++)
 471                 joined.append(sequence[v]).append(seperator);
 472         joined.append(sequence[end]);
 473 }
 474
 475 irc::stringjoiner::stringjoiner(const std::string &seperator, const std::deque<std::string> &sequence, int begin, int end)
 476 {
 477         if (end < begin)
 478                 return; // nothing to do here
 479
 480         for (int v = begin; v < end; v++)
 481                 joined.append(sequence[v]).append(seperator);
 482         joined.append(sequence[end]);
 483 }
 484
 485 irc::stringjoiner::stringjoiner(const std::string &seperator, const char* const* sequence, int begin, int end)
 486 {
 487         if (end < begin)
 488                 return; // nothing to do here
 489
 490         for (int v = begin; v < end; v++)
 491                 joined.append(sequence[v]).append(seperator);
 492         joined.append(sequence[end]);
 493 }
 494
 495 std::string& irc::stringjoiner::GetJoined()
 496 {
 497         return joined;
 498 }
 499
 500 irc::portparser::portparser(const std::string &source, bool allow_overlapped)
 501         : sep(source), in_range(0), range_begin(0), range_end(0), overlapped(allow_overlapped)
 502 {
 503 }
 504
 505 bool irc::portparser::Overlaps(long val)
 506 {
 507         if (overlapped)
 508                 return false;
 509
 510         return (!overlap_set.insert(val).second);
 511 }
 512
 513 long irc::portparser::GetToken()
 514 {
 515         if (in_range > 0)
 516         {
 517                 in_range++;
 518                 if (in_range <= range_end)
 519                 {
 520                         if (!Overlaps(in_range))
 521                         {
 522                                 return in_range;
 523                         }
 524                         else
 525                         {
 526                                 while (((Overlaps(in_range)) && (in_range <= range_end)))
 527                                         in_range++;
 528
 529                                 if (in_range <= range_end)
 530                                         return in_range;
 531                         }
 532                 }
 533                 else
 534                         in_range = 0;
 535         }
 536
 537         std::string x;
 538         sep.GetToken(x);
 539
 540         if (x.empty())
 541                 return 0;
 542
 543         while (Overlaps(atoi(x.c_str())))
 544         {
 545                 if (!sep.GetToken(x))
 546                         return 0;
 547         }
 548
 549         std::string::size_type dash = x.rfind('-');
 550         if (dash != std::string::npos)
 551         {
 552                 std::string sbegin = x.substr(0, dash);
 553                 std::string send = x.substr(dash+1, x.length());
 554                 range_begin = atoi(sbegin.c_str());
 555                 range_end = atoi(send.c_str());
 556
 557                 if ((range_begin > 0) && (range_end > 0) && (range_begin < 65536) && (range_end < 65536) && (range_begin < range_end))
 558                 {
 559                         in_range = range_begin;
 560                         return in_range;
 561                 }
 562                 else
 563                 {
 564                         /* Assume its just the one port */
 565                         return atoi(sbegin.c_str());
 566                 }
 567         }
 568         else
 569         {
 570                 return atoi(x.c_str());
 571         }
 572 }