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 #include "inspircd.h"
  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 unordered_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
  51 /**
  52  * A case insensitive mapping of characters from upper case to lower case for
  53  * the ASCII character set.
  54  */
  55 unsigned const char ascii_case_insensitive_map[256] = {
  56         0,   1,   2,   3,   4,   5,   6,   7,   8,   9,   // 0-9
  57         10,  11,  12,  13,  14,  15,  16,  17,  18,  19,  // 10-19
  58         20,  21,  22,  23,  24,  25,  26,  27,  28,  29,  // 20-29
  59         30,  31,  32,  33,  34,  35,  36,  37,  38,  39,  // 30-39
  60         40,  41,  42,  43,  44,  45,  46,  47,  48,  49,  // 40-49
  61         50,  51,  52,  53,  54,  55,  56,  57,  58,  59,  // 50-59
  62         60,  61,  62,  63,  64,  97,  98,  99,  100, 101, // 60-69
  63         102, 103, 104, 105, 106, 107, 108, 109, 110, 111, // 70-79
  64         112, 113, 114, 115, 116, 117, 118, 119, 120, 121, // 80-89
  65         122, 91,  92,  93,  94,  95,  96,  97,  98,  99,  // 90-99
  66         100, 101, 102, 103, 104, 105, 106, 107, 108, 109, // 100-109
  67         110, 111, 112, 113, 114, 115, 116, 117, 118, 119, // 110-119
  68         120, 121, 122, 123, 124, 125, 126, 127, 128, 129, // 120-129
  69         130, 131, 132, 133, 134, 135, 136, 137, 138, 139, // 130-139
  70         140, 141, 142, 143, 144, 145, 146, 147, 148, 149, // 140-149
  71         150, 151, 152, 153, 154, 155, 156, 157, 158, 159, // 150-159
  72         160, 161, 162, 163, 164, 165, 166, 167, 168, 169, // 160-169
  73         170, 171, 172, 173, 174, 175, 176, 177, 178, 179, // 170-179
  74         180, 181, 182, 183, 184, 185, 186, 187, 188, 189, // 180-189
  75         190, 191, 192, 193, 194, 195, 196, 197, 198, 199, // 190-199
  76         200, 201, 202, 203, 204, 205, 206, 207, 208, 209, // 200-209
  77         210, 211, 212, 213, 214, 215, 216, 217, 218, 219, // 210-219
  78         220, 221, 222, 223, 224, 225, 226, 227, 228, 229, // 220-229
  79         230, 231, 232, 233, 234, 235, 236, 237, 238, 239, // 230-249
  80         240, 241, 242, 243, 244, 245, 246, 247, 248, 249, // 240-249
  81         250, 251, 252, 253, 254, 255,                     // 250-255
  82 };
  83
  84
  85
  86 /**
  87  * A case insensitive mapping of characters from upper case to lower case for
  88  * the character set of RFC 1459. This is identical to ASCII with the small
  89  * exception of {}| being considered to be the lower case equivalents of the
  90  * characters []\ respectively.
  91  */
  92 unsigned const char rfc_case_insensitive_map[256] = {
  93         0,   1,   2,   3,   4,   5,   6,   7,   8,   9,   // 0-9
  94         10,  11,  12,  13,  14,  15,  16,  17,  18,  19,  // 10-19
  95         20,  21,  22,  23,  24,  25,  26,  27,  28,  29,  // 20-29
  96         30,  31,  32,  33,  34,  35,  36,  37,  38,  39,  // 30-39
  97         40,  41,  42,  43,  44,  45,  46,  47,  48,  49,  // 40-49
  98         50,  51,  52,  53,  54,  55,  56,  57,  58,  59,  // 50-59
  99         60,  61,  62,  63,  64,  97,  98,  99,  100, 101, // 60-69
 100         102, 103, 104, 105, 106, 107, 108, 109, 110, 111, // 70-79
 101         112, 113, 114, 115, 116, 117, 118, 119, 120, 121, // 80-89
 102         122, 123, 124, 125, 94,  95,  96,  97,  98,  99,  // 90-99
 103         100, 101, 102, 103, 104, 105, 106, 107, 108, 109, // 100-109
 104         110, 111, 112, 113, 114, 115, 116, 117, 118, 119, // 110-119
 105         120, 121, 122, 123, 124, 125, 126, 127, 128, 129, // 120-129
 106         130, 131, 132, 133, 134, 135, 136, 137, 138, 139, // 130-139
 107         140, 141, 142, 143, 144, 145, 146, 147, 148, 149, // 140-149
 108         150, 151, 152, 153, 154, 155, 156, 157, 158, 159, // 150-159
 109         160, 161, 162, 163, 164, 165, 166, 167, 168, 169, // 160-169
 110         170, 171, 172, 173, 174, 175, 176, 177, 178, 179, // 170-179
 111         180, 181, 182, 183, 184, 185, 186, 187, 188, 189, // 180-189
 112         190, 191, 192, 193, 194, 195, 196, 197, 198, 199, // 190-199
 113         200, 201, 202, 203, 204, 205, 206, 207, 208, 209, // 200-209
 114         210, 211, 212, 213, 214, 215, 216, 217, 218, 219, // 210-219
 115         220, 221, 222, 223, 224, 225, 226, 227, 228, 229, // 220-229
 116         230, 231, 232, 233, 234, 235, 236, 237, 238, 239, // 230-239
 117         240, 241, 242, 243, 244, 245, 246, 247, 248, 249, // 240-249
 118         250, 251, 252, 253, 254, 255,                     // 250-255
 119 };
 120
 121 bool irc::equals(const std::string& s1, const std::string& s2)
 122 {
 123         const unsigned char* n1 = (const unsigned char*)s1.c_str();
 124         const unsigned char* n2 = (const unsigned char*)s2.c_str();
 125         for (; *n1 && *n2; n1++, n2++)
 126                 if (national_case_insensitive_map[*n1] != national_case_insensitive_map[*n2])
 127                         return false;
 128         return (national_case_insensitive_map[*n1] == national_case_insensitive_map[*n2]);
 129 }
 130
 131 bool irc::insensitive_swo::operator()(const std::string& a, const std::string& b) const
 132 {
 133         const unsigned char* charmap = national_case_insensitive_map;
 134         std::string::size_type asize = a.size();
 135         std::string::size_type bsize = b.size();
 136         std::string::size_type maxsize = std::min(asize, bsize);
 137
 138         for (std::string::size_type i = 0; i < maxsize; i++)
 139         {
 140                 unsigned char A = charmap[(unsigned char)a[i]];
 141                 unsigned char B = charmap[(unsigned char)b[i]];
 142                 if (A > B)
 143                         return false;
 144                 else if (A < B)
 145                         return true;
 146         }
 147         return (asize < bsize);
 148 }
 149
 150 size_t irc::insensitive::operator()(const std::string &s) const
 151 {
 152         /* XXX: NO DATA COPIES! :)
 153          * The hash function here is practically
 154          * a copy of the one in STL's hash_fun.h,
 155          * only with *x replaced with national_case_insensitive_map[*x].
 156          * This avoids a copy to use hash<const char*>
 157          */
 158         size_t t = 0;
 159         for (std::string::const_iterator x = s.begin(); x != s.end(); ++x) /* ++x not x++, as its faster */
 160                 t = 5 * t + national_case_insensitive_map[(unsigned char)*x];
 161         return t;
 162 }
 163
 164 /******************************************************
 165  *
 166  * This is the implementation of our special irc::string
 167  * class which is a case-insensitive equivalent to
 168  * std::string which is not only case-insensitive but
 169  * can also do scandanavian comparisons, e.g. { = [, etc.
 170  *
 171  * This class depends on the const array 'national_case_insensitive_map'.
 172  *
 173  ******************************************************/
 174
 175 bool irc::irc_char_traits::eq(char c1st, char c2nd)
 176 {
 177         return national_case_insensitive_map[(unsigned char)c1st] == national_case_insensitive_map[(unsigned char)c2nd];
 178 }
 179
 180 bool irc::irc_char_traits::ne(char c1st, char c2nd)
 181 {
 182         return national_case_insensitive_map[(unsigned char)c1st] != national_case_insensitive_map[(unsigned char)c2nd];
 183 }
 184
 185 bool irc::irc_char_traits::lt(char c1st, char c2nd)
 186 {
 187         return national_case_insensitive_map[(unsigned char)c1st] < national_case_insensitive_map[(unsigned char)c2nd];
 188 }
 189
 190 int irc::irc_char_traits::compare(const char* str1, const char* str2, size_t n)
 191 {
 192         for(unsigned int i = 0; i < n; i++)
 193         {
 194                 if(national_case_insensitive_map[(unsigned char)*str1] > national_case_insensitive_map[(unsigned char)*str2])
 195                         return 1;
 196
 197                 if(national_case_insensitive_map[(unsigned char)*str1] < national_case_insensitive_map[(unsigned char)*str2])
 198                         return -1;
 199
 200                 if(*str1 == 0 || *str2 == 0)
 201                         return 0;
 202
 203                 str1++;
 204                 str2++;
 205         }
 206         return 0;
 207 }
 208
 209 const char* irc::irc_char_traits::find(const char* s1, int  n, char c)
 210 {
 211         while(n-- > 0 && national_case_insensitive_map[(unsigned char)*s1] != national_case_insensitive_map[(unsigned char)c])
 212                 s1++;
 213         return (n >= 0) ? s1 : NULL;
 214 }
 215
 216 irc::tokenstream::tokenstream(const std::string &source) : spacesepstream(source)
 217 {
 218 }
 219
 220 bool irc::tokenstream::GetToken(std::string &token)
 221 {
 222         bool first = !pos;
 223
 224         if (!spacesepstream::GetToken(token))
 225                 return false;
 226
 227         /* This is the last parameter */
 228         if (token[0] == ':' && !first)
 229         {
 230                 token.erase(token.begin());
 231                 if (!StreamEnd())
 232                 {
 233                         token += ' ';
 234                         token += GetRemaining();
 235                 }
 236                 pos = tokens.length() + 1;
 237         }
 238
 239         return true;
 240 }
 241
 242 bool irc::tokenstream::GetToken(int &token)
 243 {
 244         std::string tok;
 245         bool returnval = GetToken(tok);
 246         token = ConvToInt(tok);
 247         return returnval;
 248 }
 249
 250 bool irc::tokenstream::GetToken(long &token)
 251 {
 252         std::string tok;
 253         bool returnval = GetToken(tok);
 254         token = ConvToInt(tok);
 255         return returnval;
 256 }
 257
 258 irc::sepstream::sepstream(const std::string& source, char separator, bool allowempty)
 259         : tokens(source), sep(separator), pos(0), allow_empty(allowempty)
 260 {
 261 }
 262
 263 bool irc::sepstream::GetToken(std::string &token)
 264 {
 265         if (this->StreamEnd())
 266         {
 267                 token.clear();
 268                 return false;
 269         }
 270
 271         if (!this->allow_empty)
 272         {
 273                 this->pos = this->tokens.find_first_not_of(this->sep, this->pos);
 274                 if (this->pos == std::string::npos)
 275                 {
 276                         this->pos = this->tokens.length() + 1;
 277                         token.clear();
 278                         return false;
 279                 }
 280         }
 281
 282         size_t p = this->tokens.find(this->sep, this->pos);
 283         if (p == std::string::npos)
 284                 p = this->tokens.length();
 285
 286         token.assign(tokens, this->pos, p - this->pos);
 287         this->pos = p + 1;
 288
 289         return true;
 290 }
 291
 292 const std::string irc::sepstream::GetRemaining()
 293 {
 294         return !this->StreamEnd() ? this->tokens.substr(this->pos) : "";
 295 }
 296
 297 bool irc::sepstream::StreamEnd()
 298 {
 299         return this->pos > this->tokens.length();
 300 }
 301
 302 std::string irc::stringjoiner(const std::vector<std::string>& sequence, char separator)
 303 {
 304         std::string joined;
 305         if (sequence.empty())
 306                 return joined; // nothing to do here
 307
 308         for (std::vector<std::string>::const_iterator i = sequence.begin(); i != sequence.end(); ++i)
 309                 joined.append(*i).push_back(separator);
 310         joined.erase(joined.end()-1);
 311         return joined;
 312 }
 313
 314 irc::portparser::portparser(const std::string &source, bool allow_overlapped)
 315         : sep(source), in_range(0), range_begin(0), range_end(0), overlapped(allow_overlapped)
 316 {
 317 }
 318
 319 bool irc::portparser::Overlaps(long val)
 320 {
 321         if (overlapped)
 322                 return false;
 323
 324         return (!overlap_set.insert(val).second);
 325 }
 326
 327 long irc::portparser::GetToken()
 328 {
 329         if (in_range > 0)
 330         {
 331                 in_range++;
 332                 if (in_range <= range_end)
 333                 {
 334                         if (!Overlaps(in_range))
 335                         {
 336                                 return in_range;
 337                         }
 338                         else
 339                         {
 340                                 while (((Overlaps(in_range)) && (in_range <= range_end)))
 341                                         in_range++;
 342
 343                                 if (in_range <= range_end)
 344                                         return in_range;
 345                         }
 346                 }
 347                 else
 348                         in_range = 0;
 349         }
 350
 351         std::string x;
 352         sep.GetToken(x);
 353
 354         if (x.empty())
 355                 return 0;
 356
 357         while (Overlaps(atoi(x.c_str())))
 358         {
 359                 if (!sep.GetToken(x))
 360                         return 0;
 361         }
 362
 363         std::string::size_type dash = x.rfind('-');
 364         if (dash != std::string::npos)
 365         {
 366                 std::string sbegin(x, 0, dash);
 367                 range_begin = atoi(sbegin.c_str());
 368                 range_end = atoi(x.c_str()+dash+1);
 369
 370                 if ((range_begin > 0) && (range_end > 0) && (range_begin < 65536) && (range_end < 65536) && (range_begin < range_end))
 371                 {
 372                         in_range = range_begin;
 373                         return in_range;
 374                 }
 375                 else
 376                 {
 377                         /* Assume its just the one port */
 378                         return atoi(sbegin.c_str());
 379                 }
 380         }
 381         else
 382         {
 383                 return atoi(x.c_str());
 384         }
 385 }