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