src/hashcomp.cpp

   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 #include "inspircd.h"
  15 #include "hashcomp.h"
  16 #ifndef WIN32
  17 #include <ext/hash_map>
  18 #define nspace __gnu_cxx
  19 #else
  20 #include <hash_map>
  21 #define nspace stdext
  22 using stdext::hash_map;
  23 #endif
  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 hash_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 using namespace irc::sockets;
  51
  52 /* convert a string to lowercase. Note following special circumstances
  53  * taken from RFC 1459. Many "official" server branches still hold to this
  54  * rule so i will too;
  55  *
  56  *  Because of IRC's scandanavian origin, the characters {}| are
  57  *  considered to be the lower case equivalents of the characters []\,
  58  *  respectively. This is a critical issue when determining the
  59  *  equivalence of two nicknames.
  60  */
  61 void nspace::strlower(char *n)
  62 {
  63         if (n)
  64         {
  65                 for (char* t = n; *t; t++)
  66                         *t = lowermap[(unsigned char)*t];
  67         }
  68 }
  69
  70 #ifndef WIN32
  71 size_t nspace::hash<string>::operator()(const string &s) const
  72 #else
  73 size_t nspace::hash_compare<string, std::less<string> >::operator()(const string &s) const
  74 #endif
  75 {
  76         /* XXX: NO DATA COPIES! :)
  77          * The hash function here is practically
  78          * a copy of the one in STL's hash_fun.h,
  79          * only with *x replaced with lowermap[*x].
  80          * This avoids a copy to use hash<const char*>
  81          */
  82         register size_t t = 0;
  83         for (std::string::const_iterator x = s.begin(); x != s.end(); ++x) /* ++x not x++, as its faster */
  84                 t = 5 * t + lowermap[(unsigned char)*x];
  85         return t;
  86 }
  87
  88 #ifndef WIN32
  89 size_t nspace::hash<irc::string>::operator()(const irc::string &s) const
  90 #else
  91 size_t nspace::hash_compare<irc::string, std::less<irc::string> >::operator()(const irc::string &s) const
  92 #endif
  93 {
  94         register size_t t = 0;
  95         for (irc::string::const_iterator x = s.begin(); x != s.end(); ++x) /* ++x not x++, as its faster */
  96                 t = 5 * t + lowermap[(unsigned char)*x];
  97         return t;
  98 }
  99
 100 bool irc::StrHashComp::operator()(const std::string& s1, const std::string& s2) const
 101 {
 102         unsigned char* n1 = (unsigned char*)s1.c_str();
 103         unsigned char* n2 = (unsigned char*)s2.c_str();
 104         for (; *n1 && *n2; n1++, n2++)
 105                 if (lowermap[*n1] != lowermap[*n2])
 106                         return false;
 107         return (lowermap[*n1] == lowermap[*n2]);
 108 }
 109
 110 /******************************************************
 111  *
 112  * This is the implementation of our special irc::string
 113  * class which is a case-insensitive equivalent to
 114  * std::string which is not only case-insensitive but
 115  * can also do scandanavian comparisons, e.g. { = [, etc.
 116  *
 117  * This class depends on the const array 'lowermap'.
 118  *
 119  ******************************************************/
 120
 121 bool irc::irc_char_traits::eq(char c1st, char c2nd)
 122 {
 123         return lowermap[(unsigned char)c1st] == lowermap[(unsigned char)c2nd];
 124 }
 125
 126 bool irc::irc_char_traits::ne(char c1st, char c2nd)
 127 {
 128         return lowermap[(unsigned char)c1st] != lowermap[(unsigned char)c2nd];
 129 }
 130
 131 bool irc::irc_char_traits::lt(char c1st, char c2nd)
 132 {
 133         return lowermap[(unsigned char)c1st] < lowermap[(unsigned char)c2nd];
 134 }
 135
 136 int irc::irc_char_traits::compare(const char* str1, const char* str2, size_t n)
 137 {
 138         for(unsigned int i = 0; i < n; i++)
 139         {
 140                 if(lowermap[(unsigned char)*str1] > lowermap[(unsigned char)*str2])
 141                         return 1;
 142
 143                 if(lowermap[(unsigned char)*str1] < lowermap[(unsigned char)*str2])
 144                         return -1;
 145
 146                 if(*str1 == 0 || *str2 == 0)
 147                         return 0;
 148
 149                 str1++;
 150                 str2++;
 151         }
 152         return 0;
 153 }
 154
 155 const char* irc::irc_char_traits::find(const char* s1, int  n, char c)
 156 {
 157         while(n-- > 0 && lowermap[(unsigned char)*s1] != lowermap[(unsigned char)c])
 158                 s1++;
 159         return s1;
 160 }
 161
 162 irc::tokenstream::tokenstream(const std::string &source) : tokens(source), last_pushed(false)
 163 {
 164         /* Record starting position and current position */
 165         last_starting_position = tokens.begin();
 166         n = tokens.begin();
 167 }
 168
 169 irc::tokenstream::~tokenstream()
 170 {
 171 }
 172
 173 bool irc::tokenstream::GetToken(std::string &token)
 174 {
 175         std::string::iterator lsp = last_starting_position;
 176
 177         while (n != tokens.end())
 178         {
 179                 /** Skip multi space, converting "  " into " "
 180                  */
 181                 while ((n+1 != tokens.end()) && (*n == ' ') && (*(n+1) == ' '))
 182                         n++;
 183
 184                 if ((last_pushed) && (*n == ':'))
 185                 {
 186                         /* If we find a token thats not the first and starts with :,
 187                          * this is the last token on the line
 188                          */
 189                         std::string::iterator curr = ++n;
 190                         n = tokens.end();
 191                         token = std::string(curr, tokens.end());
 192                         return true;
 193                 }
 194
 195                 last_pushed = false;
 196
 197                 if ((*n == ' ') || (n+1 == tokens.end()))
 198                 {
 199                         /* If we find a space, or end of string, this is the end of a token.
 200                          */
 201                         last_starting_position = n+1;
 202                         last_pushed = true;
 203
 204                         std::string strip(lsp, n+1 == tokens.end() ? n+1  : n++);
 205                         while ((strip.length()) && (strip.find_last_of(' ') == strip.length() - 1))
 206                                 strip.erase(strip.end() - 1);
 207
 208                         token = strip;
 209                         return !token.empty();
 210                 }
 211
 212                 n++;
 213         }
 214         token.clear();
 215         return false;
 216 }
 217
 218 bool irc::tokenstream::GetToken(irc::string &token)
 219 {
 220         std::string stdstring;
 221         bool returnval = GetToken(stdstring);
 222         token = assign(stdstring);
 223         return returnval;
 224 }
 225
 226 bool irc::tokenstream::GetToken(int &token)
 227 {
 228         std::string tok;
 229         bool returnval = GetToken(tok);
 230         token = ConvToInt(tok);
 231         return returnval;
 232 }
 233
 234 bool irc::tokenstream::GetToken(long &token)
 235 {
 236         std::string tok;
 237         bool returnval = GetToken(tok);
 238         token = ConvToInt(tok);
 239         return returnval;
 240 }
 241
 242 irc::sepstream::sepstream(const std::string &source, char seperator) : tokens(source), sep(seperator)
 243 {
 244         last_starting_position = tokens.begin();
 245         n = tokens.begin();
 246 }
 247
 248 const std::string irc::sepstream::GetToken()
 249 {
 250         std::string::iterator lsp = last_starting_position;
 251
 252         while (n != tokens.end())
 253         {
 254                 if ((*n == sep) || (n+1 == tokens.end()))
 255                 {
 256                         last_starting_position = n+1;
 257                         std::string strip = std::string(lsp, n+1 == tokens.end() ? n+1  : n++);
 258
 259                         while ((strip.length()) && (strip.find_last_of(sep) == strip.length() - 1))
 260                                 strip.erase(strip.end() - 1);
 261
 262                         return strip;
 263                 }
 264
 265                 n++;
 266         }
 267
 268         return "";
 269 }
 270
 271 const std::string irc::sepstream::GetRemaining()
 272 {
 273         return std::string(n, tokens.end());
 274 }
 275
 276 bool irc::sepstream::StreamEnd()
 277 {
 278         return ((n + 1) == tokens.end());
 279 }
 280
 281 irc::sepstream::~sepstream()
 282 {
 283 }
 284
 285 std::string irc::hex(const unsigned char *raw, size_t rawsz)
 286 {
 287         if (!rawsz)
 288                 return "";
 289
 290         /* EWW! This used to be using sprintf, which is WAY inefficient. -Special */
 291
 292         const char *hex = "0123456789abcdef";
 293         static char hexbuf[MAXBUF];
 294
 295         size_t i, j;
 296         for (i = 0, j = 0; j < rawsz; ++j)
 297         {
 298                 hexbuf[i++] = hex[raw[j] / 16];
 299                 hexbuf[i++] = hex[raw[j] % 16];
 300         }
 301         hexbuf[i] = 0;
 302
 303         return hexbuf;
 304 }
 305
 306 CoreExport const char* irc::Spacify(const char* n)
 307 {
 308         static char x[MAXBUF];
 309         strlcpy(x,n,MAXBUF);
 310         for (char* y = x; *y; y++)
 311                 if (*y == '_')
 312                         *y = ' ';
 313         return x;
 314 }
 315
 316
 317 irc::modestacker::modestacker(bool add) : adding(add)
 318 {
 319         sequence.clear();
 320         sequence.push_back("");
 321 }
 322
 323 void irc::modestacker::Push(char modeletter, const std::string &parameter)
 324 {
 325         *(sequence.begin()) += modeletter;
 326         sequence.push_back(parameter);
 327 }
 328
 329 void irc::modestacker::Push(char modeletter)
 330 {
 331         this->Push(modeletter,"");
 332 }
 333
 334 void irc::modestacker::PushPlus()
 335 {
 336         this->Push('+',"");
 337 }
 338
 339 void irc::modestacker::PushMinus()
 340 {
 341         this->Push('-',"");
 342 }
 343
 344 int irc::modestacker::GetStackedLine(std::deque<std::string> &result, int max_line_size)
 345 {
 346         if (sequence.empty())
 347         {
 348                 result.clear();
 349                 return 0;
 350         }
 351
 352         int n = 0;
 353         int size = 1; /* Account for initial +/- char */
 354         int nextsize = 0;
 355         result.clear();
 356         result.push_back(adding ? "+" : "-");
 357
 358         if (sequence.size() > 1)
 359                 nextsize = sequence[1].length() + 2;
 360
 361         while (!sequence[0].empty() && (sequence.size() > 1) && (result.size() < MAXMODES) && ((size + nextsize) < max_line_size))
 362         {
 363                 result[0] += *(sequence[0].begin());
 364                 if (!sequence[1].empty())
 365                 {
 366                         result.push_back(sequence[1]);
 367                         size += nextsize; /* Account for mode character and whitespace */
 368                 }
 369                 sequence[0].erase(sequence[0].begin());
 370                 sequence.erase(sequence.begin() + 1);
 371
 372                 if (sequence.size() > 1)
 373                         nextsize = sequence[1].length() + 2;
 374
 375                 n++;
 376         }
 377
 378         return n;
 379 }
 380
 381 irc::stringjoiner::stringjoiner(const std::string &seperator, const std::vector<std::string> &sequence, int begin, int end)
 382 {
 383         for (int v = begin; v < end; v++)
 384                 joined.append(sequence[v]).append(seperator);
 385         joined.append(sequence[end]);
 386 }
 387
 388 irc::stringjoiner::stringjoiner(const std::string &seperator, const std::deque<std::string> &sequence, int begin, int end)
 389 {
 390         for (int v = begin; v < end; v++)
 391                 joined.append(sequence[v]).append(seperator);
 392         joined.append(sequence[end]);
 393 }
 394
 395 irc::stringjoiner::stringjoiner(const std::string &seperator, const char** sequence, int begin, int end)
 396 {
 397         for (int v = begin; v < end; v++)
 398                 joined.append(sequence[v]).append(seperator);
 399         joined.append(sequence[end]);
 400 }
 401
 402 std::string& irc::stringjoiner::GetJoined()
 403 {
 404         return joined;
 405 }
 406
 407 irc::portparser::portparser(const std::string &source, bool allow_overlapped) : in_range(0), range_begin(0), range_end(0), overlapped(allow_overlapped)
 408 {
 409         sep = new irc::commasepstream(source);
 410         overlap_set.clear();
 411 }
 412
 413 irc::portparser::~portparser()
 414 {
 415         delete sep;
 416 }
 417
 418 bool irc::portparser::Overlaps(long val)
 419 {
 420         if (!overlapped)
 421                 return false;
 422
 423         if (overlap_set.find(val) == overlap_set.end())
 424         {
 425                 overlap_set[val] = true;
 426                 return false;
 427         }
 428         else
 429                 return true;
 430 }
 431
 432 long irc::portparser::GetToken()
 433 {
 434         if (in_range > 0)
 435         {
 436                 in_range++;
 437                 if (in_range <= range_end)
 438                 {
 439                         if (!Overlaps(in_range))
 440                         {
 441                                 return in_range;
 442                         }
 443                         else
 444                         {
 445                                 while (((Overlaps(in_range)) && (in_range <= range_end)))
 446                                         in_range++;
 447
 448                                 if (in_range <= range_end)
 449                                         return in_range;
 450                         }
 451                 }
 452                 else
 453                         in_range = 0;
 454         }
 455
 456         std::string x = sep->GetToken();
 457
 458         if (x.empty())
 459                 return 0;
 460
 461         while (Overlaps(atoi(x.c_str())))
 462         {
 463                 x = sep->GetToken();
 464
 465                 if (x.empty())
 466                         return 0;
 467         }
 468
 469         std::string::size_type dash = x.rfind('-');
 470         if (dash != std::string::npos)
 471         {
 472                 std::string sbegin = x.substr(0, dash);
 473                 std::string send = x.substr(dash+1, x.length());
 474                 range_begin = atoi(sbegin.c_str());
 475                 range_end = atoi(send.c_str());
 476
 477                 if ((range_begin > 0) && (range_end > 0) && (range_begin < 65536) && (range_end < 65536) && (range_begin < range_end))
 478                 {
 479                         in_range = range_begin;
 480                         return in_range;
 481                 }
 482                 else
 483                 {
 484                         /* Assume its just the one port */
 485                         return atoi(sbegin.c_str());
 486                 }
 487         }
 488         else
 489         {
 490                 return atoi(x.c_str());
 491         }
 492 }
 493
 494 irc::dynamicbitmask::dynamicbitmask() : bits_size(4)
 495 {
 496         /* We start with 4 bytes allocated which is room
 497          * for 4 items. Something makes me doubt its worth
 498          * allocating less than 4 bytes.
 499          */
 500         bits = new unsigned char[bits_size];
 501         memset(bits, 0, bits_size);
 502 }
 503
 504 irc::dynamicbitmask::~dynamicbitmask()
 505 {
 506         /* Tidy up the entire used memory on delete */
 507         delete[] bits;
 508 }
 509
 510 irc::bitfield irc::dynamicbitmask::Allocate()
 511 {
 512         /* Yeah, this isnt too efficient, however a module or the core
 513          * should only be allocating bitfields on load, the Toggle and
 514          * Get methods are O(1) as these are called much more often.
 515          */
 516         unsigned char* freebits = this->GetFreeBits();
 517         for (unsigned char i = 0; i < bits_size; i++)
 518         {
 519                 /* Yes, this is right. You'll notice we terminate the  loop when !current_pos,
 520                  * this is because we logic shift our bit off the end of unsigned char, and its
 521                  * lost, making the loop counter 0 when we're done.
 522                  */
 523                 for (unsigned char current_pos = 1; current_pos; current_pos = current_pos << 1)
 524                 {
 525                         if (!(freebits[i] & current_pos))
 526                         {
 527                                 freebits[i] |= current_pos;
 528                                 return std::make_pair(i, current_pos);
 529                         }
 530                 }
 531         }
 532         /* We dont have any free space left, increase by one */
 533
 534         if (bits_size == 255)
 535                 /* Oh dear, cant grow it any further */
 536                 throw std::bad_alloc();
 537
 538         unsigned char old_bits_size = bits_size;
 539         bits_size++;
 540         /* Allocate new bitfield space */
 541         unsigned char* temp_bits = new unsigned char[bits_size];
 542         unsigned char* temp_freebits = new unsigned char[bits_size];
 543         /* Copy the old data in */
 544         memcpy(temp_bits, bits, old_bits_size);
 545         memcpy(temp_freebits, freebits, old_bits_size);
 546         /* Delete the old data pointers */
 547         delete[] bits;
 548         delete[] freebits;
 549         /* Swap the pointers over so now the new
 550          * pointers point to our member values
 551          */
 552         bits = temp_bits;
 553         freebits = temp_freebits;
 554         this->SetFreeBits(freebits);
 555         /* Initialize the new byte on the end of
 556          * the bitfields, pre-allocate the one bit
 557          * for this allocation
 558          */
 559         bits[old_bits_size] = 0;
 560         freebits[old_bits_size] = 1;
 561         /* We already know where we just allocated
 562          * the bitfield, so no loop needed
 563          */
 564         return std::make_pair(old_bits_size, 1);
 565 }
 566
 567 bool irc::dynamicbitmask::Deallocate(irc::bitfield &pos)
 568 {
 569         /* We dont bother to shrink the bitfield
 570          * on deallocation, the most we could do
 571          * is save one byte (!) and this would cost
 572          * us a loop (ugly O(n) stuff) so we just
 573          * clear the bit and leave the memory
 574          * claimed -- nobody will care about one
 575          * byte.
 576          */
 577         if (pos.first < bits_size)
 578         {
 579                 this->GetFreeBits()[pos.first] &= ~pos.second;
 580                 return true;
 581         }
 582         /* They gave a bitfield outside of the
 583          * length of our array. BAD programmer.
 584          */
 585         return false;
 586 }
 587
 588 void irc::dynamicbitmask::Toggle(irc::bitfield &pos, bool state)
 589 {
 590         /* Range check the value */
 591         if (pos.first < bits_size)
 592         {
 593                 if (state)
 594                         /* Set state, OR the state in */
 595                         bits[pos.first] |= pos.second;
 596                 else
 597                         /* Clear state, AND the !state out */
 598                         bits[pos.first] &= ~pos.second;
 599         }
 600 }
 601
 602 bool irc::dynamicbitmask::Get(irc::bitfield &pos)
 603 {
 604         /* Range check the value */
 605         if (pos.first < bits_size)
 606                 return (bits[pos.first] & pos.second);
 607         else
 608                 /* We can't return false, otherwise we can't
 609                  * distinguish between failure and a cleared bit!
 610                  * Our only sensible choice is to throw (ew).
 611                  */
 612                 throw ModuleException("irc::dynamicbitmask::Get(): Invalid bitfield, out of range");
 613 }
 614
 615 unsigned char irc::dynamicbitmask::GetSize()
 616 {
 617         return bits_size;
 618 }
 619