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
 294         std::string buf;
 295         buf.reserve(rawsz * 2 + 1);
 296
 297         size_t i, j;
 298         for (i = 0, j = 0; j < rawsz; ++j)
 299         {
 300                 buf[i++] = hex[raw[j] / 16];
 301                 buf[i++] = hex[raw[j] % 16];
 302         }
 303         buf[i] = '\0';
 304
 305         return buf;
 306 }
 307
 308 CoreExport const char* irc::Spacify(const char* n)
 309 {
 310         static char x[MAXBUF];
 311         strlcpy(x,n,MAXBUF);
 312         for (char* y = x; *y; y++)
 313                 if (*y == '_')
 314                         *y = ' ';
 315         return x;
 316 }
 317
 318
 319 irc::modestacker::modestacker(bool add) : adding(add)
 320 {
 321         sequence.clear();
 322         sequence.push_back("");
 323 }
 324
 325 void irc::modestacker::Push(char modeletter, const std::string &parameter)
 326 {
 327         *(sequence.begin()) += modeletter;
 328         sequence.push_back(parameter);
 329 }
 330
 331 void irc::modestacker::Push(char modeletter)
 332 {
 333         this->Push(modeletter,"");
 334 }
 335
 336 void irc::modestacker::PushPlus()
 337 {
 338         this->Push('+',"");
 339 }
 340
 341 void irc::modestacker::PushMinus()
 342 {
 343         this->Push('-',"");
 344 }
 345
 346 int irc::modestacker::GetStackedLine(std::deque<std::string> &result, int max_line_size)
 347 {
 348         if (sequence.empty())
 349         {
 350                 result.clear();
 351                 return 0;
 352         }
 353
 354         int n = 0;
 355         int size = 1; /* Account for initial +/- char */
 356         int nextsize = 0;
 357         result.clear();
 358         result.push_back(adding ? "+" : "-");
 359
 360         if (sequence.size() > 1)
 361                 nextsize = sequence[1].length() + 2;
 362
 363         while (!sequence[0].empty() && (sequence.size() > 1) && (result.size() < MAXMODES) && ((size + nextsize) < max_line_size))
 364         {
 365                 result[0] += *(sequence[0].begin());
 366                 if (!sequence[1].empty())
 367                 {
 368                         result.push_back(sequence[1]);
 369                         size += nextsize; /* Account for mode character and whitespace */
 370                 }
 371                 sequence[0].erase(sequence[0].begin());
 372                 sequence.erase(sequence.begin() + 1);
 373
 374                 if (sequence.size() > 1)
 375                         nextsize = sequence[1].length() + 2;
 376
 377                 n++;
 378         }
 379
 380         return n;
 381 }
 382
 383 irc::stringjoiner::stringjoiner(const std::string &seperator, const std::vector<std::string> &sequence, int begin, int end)
 384 {
 385         for (int v = begin; v < end; v++)
 386                 joined.append(sequence[v]).append(seperator);
 387         joined.append(sequence[end]);
 388 }
 389
 390 irc::stringjoiner::stringjoiner(const std::string &seperator, const std::deque<std::string> &sequence, int begin, int end)
 391 {
 392         for (int v = begin; v < end; v++)
 393                 joined.append(sequence[v]).append(seperator);
 394         joined.append(sequence[end]);
 395 }
 396
 397 irc::stringjoiner::stringjoiner(const std::string &seperator, const char** sequence, int begin, int end)
 398 {
 399         for (int v = begin; v < end; v++)
 400                 joined.append(sequence[v]).append(seperator);
 401         joined.append(sequence[end]);
 402 }
 403
 404 std::string& irc::stringjoiner::GetJoined()
 405 {
 406         return joined;
 407 }
 408
 409 irc::portparser::portparser(const std::string &source, bool allow_overlapped) : in_range(0), range_begin(0), range_end(0), overlapped(allow_overlapped)
 410 {
 411         sep = new irc::commasepstream(source);
 412         overlap_set.clear();
 413 }
 414
 415 irc::portparser::~portparser()
 416 {
 417         delete sep;
 418 }
 419
 420 bool irc::portparser::Overlaps(long val)
 421 {
 422         if (!overlapped)
 423                 return false;
 424
 425         if (overlap_set.find(val) == overlap_set.end())
 426         {
 427                 overlap_set[val] = true;
 428                 return false;
 429         }
 430         else
 431                 return true;
 432 }
 433
 434 long irc::portparser::GetToken()
 435 {
 436         if (in_range > 0)
 437         {
 438                 in_range++;
 439                 if (in_range <= range_end)
 440                 {
 441                         if (!Overlaps(in_range))
 442                         {
 443                                 return in_range;
 444                         }
 445                         else
 446                         {
 447                                 while (((Overlaps(in_range)) && (in_range <= range_end)))
 448                                         in_range++;
 449
 450                                 if (in_range <= range_end)
 451                                         return in_range;
 452                         }
 453                 }
 454                 else
 455                         in_range = 0;
 456         }
 457
 458         std::string x = sep->GetToken();
 459
 460         if (x.empty())
 461                 return 0;
 462
 463         while (Overlaps(atoi(x.c_str())))
 464         {
 465                 x = sep->GetToken();
 466
 467                 if (x.empty())
 468                         return 0;
 469         }
 470
 471         std::string::size_type dash = x.rfind('-');
 472         if (dash != std::string::npos)
 473         {
 474                 std::string sbegin = x.substr(0, dash);
 475                 std::string send = x.substr(dash+1, x.length());
 476                 range_begin = atoi(sbegin.c_str());
 477                 range_end = atoi(send.c_str());
 478
 479                 if ((range_begin > 0) && (range_end > 0) && (range_begin < 65536) && (range_end < 65536) && (range_begin < range_end))
 480                 {
 481                         in_range = range_begin;
 482                         return in_range;
 483                 }
 484                 else
 485                 {
 486                         /* Assume its just the one port */
 487                         return atoi(sbegin.c_str());
 488                 }
 489         }
 490         else
 491         {
 492                 return atoi(x.c_str());
 493         }
 494 }
 495
 496 irc::dynamicbitmask::dynamicbitmask() : bits_size(4)
 497 {
 498         /* We start with 4 bytes allocated which is room
 499          * for 4 items. Something makes me doubt its worth
 500          * allocating less than 4 bytes.
 501          */
 502         bits = new unsigned char[bits_size];
 503         memset(bits, 0, bits_size);
 504 }
 505
 506 irc::dynamicbitmask::~dynamicbitmask()
 507 {
 508         /* Tidy up the entire used memory on delete */
 509         delete[] bits;
 510 }
 511
 512 irc::bitfield irc::dynamicbitmask::Allocate()
 513 {
 514         /* Yeah, this isnt too efficient, however a module or the core
 515          * should only be allocating bitfields on load, the Toggle and
 516          * Get methods are O(1) as these are called much more often.
 517          */
 518         unsigned char* freebits = this->GetFreeBits();
 519         for (unsigned char i = 0; i < bits_size; i++)
 520         {
 521                 /* Yes, this is right. You'll notice we terminate the  loop when !current_pos,
 522                  * this is because we logic shift our bit off the end of unsigned char, and its
 523                  * lost, making the loop counter 0 when we're done.
 524                  */
 525                 for (unsigned char current_pos = 1; current_pos; current_pos = current_pos << 1)
 526                 {
 527                         if (!(freebits[i] & current_pos))
 528                         {
 529                                 freebits[i] |= current_pos;
 530                                 return std::make_pair(i, current_pos);
 531                         }
 532                 }
 533         }
 534         /* We dont have any free space left, increase by one */
 535
 536         if (bits_size == 255)
 537                 /* Oh dear, cant grow it any further */
 538                 throw std::bad_alloc();
 539
 540         unsigned char old_bits_size = bits_size;
 541         bits_size++;
 542         /* Allocate new bitfield space */
 543         unsigned char* temp_bits = new unsigned char[bits_size];
 544         unsigned char* temp_freebits = new unsigned char[bits_size];
 545         /* Copy the old data in */
 546         memcpy(temp_bits, bits, old_bits_size);
 547         memcpy(temp_freebits, freebits, old_bits_size);
 548         /* Delete the old data pointers */
 549         delete[] bits;
 550         delete[] freebits;
 551         /* Swap the pointers over so now the new
 552          * pointers point to our member values
 553          */
 554         bits = temp_bits;
 555         freebits = temp_freebits;
 556         this->SetFreeBits(freebits);
 557         /* Initialize the new byte on the end of
 558          * the bitfields, pre-allocate the one bit
 559          * for this allocation
 560          */
 561         bits[old_bits_size] = 0;
 562         freebits[old_bits_size] = 1;
 563         /* We already know where we just allocated
 564          * the bitfield, so no loop needed
 565          */
 566         return std::make_pair(old_bits_size, 1);
 567 }
 568
 569 bool irc::dynamicbitmask::Deallocate(irc::bitfield &pos)
 570 {
 571         /* We dont bother to shrink the bitfield
 572          * on deallocation, the most we could do
 573          * is save one byte (!) and this would cost
 574          * us a loop (ugly O(n) stuff) so we just
 575          * clear the bit and leave the memory
 576          * claimed -- nobody will care about one
 577          * byte.
 578          */
 579         if (pos.first < bits_size)
 580         {
 581                 this->GetFreeBits()[pos.first] &= ~pos.second;
 582                 return true;
 583         }
 584         /* They gave a bitfield outside of the
 585          * length of our array. BAD programmer.
 586          */
 587         return false;
 588 }
 589
 590 void irc::dynamicbitmask::Toggle(irc::bitfield &pos, bool state)
 591 {
 592         /* Range check the value */
 593         if (pos.first < bits_size)
 594         {
 595                 if (state)
 596                         /* Set state, OR the state in */
 597                         bits[pos.first] |= pos.second;
 598                 else
 599                         /* Clear state, AND the !state out */
 600                         bits[pos.first] &= ~pos.second;
 601         }
 602 }
 603
 604 bool irc::dynamicbitmask::Get(irc::bitfield &pos)
 605 {
 606         /* Range check the value */
 607         if (pos.first < bits_size)
 608                 return (bits[pos.first] & pos.second);
 609         else
 610                 /* We can't return false, otherwise we can't
 611                  * distinguish between failure and a cleared bit!
 612                  * Our only sensible choice is to throw (ew).
 613                  */
 614                 throw ModuleException("irc::dynamicbitmask::Get(): Invalid bitfield, out of range");
 615 }
 616
 617 unsigned char irc::dynamicbitmask::GetSize()
 618 {
 619         return bits_size;
 620 }
 621