src/hashcomp.cpp

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