include/hashcomp.h

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2011 Adam <Adam@anope.org>
   5  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   6  *   Copyright (C) 2007, 2009 Dennis Friis <peavey@inspircd.org>
   7  *   Copyright (C) 2005-2009 Craig Edwards <craigedwards@brainbox.cc>
   8  *   Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
   9  *   Copyright (C) 2008 Pippijn van Steenhoven <pip88nl@gmail.com>
  10  *
  11  * This file is part of InspIRCd.  InspIRCd is free software: you can
  12  * redistribute it and/or modify it under the terms of the GNU General Public
  13  * License as published by the Free Software Foundation, version 2.
  14  *
  15  * This program is distributed in the hope that it will be useful, but WITHOUT
  16  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  17  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  18  * details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  */
  23
  24
  25 #pragma once
  26
  27 #include <cstring>
  28 #include <string>
  29 #include <vector>
  30 #include <deque>
  31 #include <map>
  32 #include <set>
  33 #include "inspircd.h"
  34
  35 /*******************************************************
  36  * This file contains classes and templates that deal
  37  * with the comparison and hashing of 'irc strings'.
  38  * An 'irc string' is a string which compares in a
  39  * case insensitive manner, and as per RFC 1459 will
  40  * treat [ identical to {, ] identical to }, and \
  41  * as identical to |.
  42  *
  43  * Our hashing functions are designed  to accept
  44  * std::string and compare/hash them as type irc::string
  45  * by converting them internally. This makes them
  46  * backwards compatible with other code which is not
  47  * aware of irc::string.
  48  *******************************************************/
  49
  50 /** Seperate from the other casemap tables so that code *can* still exclusively rely on RFC casemapping
  51  * if it must.
  52  *
  53  * This is provided as a pointer so that modules can change it to their custom mapping tables,
  54  * e.g. for national character support.
  55  */
  56 CoreExport extern unsigned const char *national_case_insensitive_map;
  57
  58 /** A mapping of uppercase to lowercase, including scandinavian
  59  * 'oddities' as specified by RFC1459, e.g. { -> [, and | -> \
  60  */
  61 CoreExport extern unsigned const char rfc_case_insensitive_map[256];
  62
  63 /** Case insensitive map, ASCII rules.
  64  * That is;
  65  * [ != {, but A == a.
  66  */
  67 CoreExport extern unsigned const char ascii_case_insensitive_map[256];
  68
  69 /** Case sensitive (identity) map.
  70  */
  71 CoreExport extern unsigned const char rfc_case_sensitive_map[256];
  72
  73 template<typename T> const T& SearchAndReplace(T& text, const T& pattern, const T& replace)
  74 {
  75         T replacement;
  76         if ((!pattern.empty()) && (!text.empty()))
  77         {
  78                 for (std::string::size_type n = 0; n != text.length(); ++n)
  79                 {
  80                         if (text.length() >= pattern.length() && text.substr(n, pattern.length()) == pattern)
  81                         {
  82                                 /* Found the pattern in the text, replace it, and advance */
  83                                 replacement.append(replace);
  84                                 n = n + pattern.length() - 1;
  85                         }
  86                         else
  87                         {
  88                                 replacement += text[n];
  89                         }
  90                 }
  91         }
  92         text = replacement;
  93         return text;
  94 }
  95
  96 /** The irc namespace contains a number of helper classes.
  97  */
  98 namespace irc
  99 {
 100
 101         /** This class returns true if two strings match.
 102          * Case sensitivity is ignored, and the RFC 'character set'
 103          * is adhered to
 104          */
 105         struct CoreExport StrHashComp
 106         {
 107                 /** The operator () does the actual comparison in hash_map
 108                  */
 109                 bool operator()(const std::string& s1, const std::string& s2) const;
 110         };
 111
 112         struct insensitive
 113         {
 114                 size_t CoreExport operator()(const std::string &s) const;
 115         };
 116
 117         struct insensitive_swo
 118         {
 119                 bool CoreExport operator()(const std::string& a, const std::string& b) const;
 120         };
 121
 122         /** The irc_char_traits class is used for RFC-style comparison of strings.
 123          * This class is used to implement irc::string, a case-insensitive, RFC-
 124          * comparing string class.
 125          */
 126         struct CoreExport irc_char_traits : public std::char_traits<char>
 127         {
 128                 /** Check if two chars match.
 129                  * @param c1st First character
 130                  * @param c2nd Second character
 131                  * @return true if the characters are equal
 132                  */
 133                 static bool eq(char c1st, char c2nd);
 134
 135                 /** Check if two chars do NOT match.
 136                  * @param c1st First character
 137                  * @param c2nd Second character
 138                  * @return true if the characters are unequal
 139                  */
 140                 static bool ne(char c1st, char c2nd);
 141
 142                 /** Check if one char is less than another.
 143                  * @param c1st First character
 144                  * @param c2nd Second character
 145                  * @return true if c1st is less than c2nd
 146                  */
 147                 static bool lt(char c1st, char c2nd);
 148
 149                 /** Compare two strings of size n.
 150                  * @param str1 First string
 151                  * @param str2 Second string
 152                  * @param n Length to compare to
 153                  * @return similar to strcmp, zero for equal, less than zero for str1
 154                  * being less and greater than zero for str1 being greater than str2.
 155                  */
 156                 static int compare(const char* str1, const char* str2, size_t n);
 157
 158                 /** Find a char within a string up to position n.
 159                  * @param s1 String to find in
 160                  * @param n Position to search up to
 161                  * @param c Character to search for
 162                  * @return Pointer to the first occurance of c in s1
 163                  */
 164                 static const char* find(const char* s1, int  n, char c);
 165         };
 166
 167         /** This typedef declares irc::string based upon irc_char_traits.
 168          */
 169         typedef std::basic_string<char, irc_char_traits, std::allocator<char> > string;
 170
 171         /** Joins the contents of a vector to a string.
 172          * @param sequence Zero or more items to join.
 173          * @separator The character to place between the items.
 174          */
 175         std::string CoreExport stringjoiner(const std::vector<std::string>& sequence, char separator = ' ');
 176
 177         /** irc::modestacker stacks mode sequences into a list.
 178          * It can then reproduce this list, clamped to a maximum of MAXMODES
 179          * values per line.
 180          */
 181         class CoreExport modestacker
 182         {
 183          private:
 184                 /** The mode sequence and its parameters
 185                  */
 186                 std::deque<std::string> sequence;
 187
 188                 /** True if the mode sequence is initially adding
 189                  * characters, false if it is initially removing
 190                  * them
 191                  */
 192                 bool adding;
 193          public:
 194
 195                 /** Construct a new modestacker.
 196                  * @param add True if the stack is adding modes,
 197                  * false if it is removing them
 198                  */
 199                 modestacker(bool add);
 200
 201                 /** Push a modeletter and its parameter onto the stack.
 202                  * No checking is performed as to if this mode actually
 203                  * requires a parameter. If you stack invalid mode
 204                  * sequences, they will be tidied if and when they are
 205                  * passed to a mode parser.
 206                  * @param modeletter The mode letter to insert
 207                  * @param parameter The parameter for the mode
 208                  */
 209                 void Push(char modeletter, const std::string &parameter);
 210
 211                 /** Push a modeletter without parameter onto the stack.
 212                  * No checking is performed as to if this mode actually
 213                  * requires a parameter. If you stack invalid mode
 214                  * sequences, they will be tidied if and when they are
 215                  * passed to a mode parser.
 216                  * @param modeletter The mode letter to insert
 217                  */
 218                 void Push(char modeletter);
 219
 220                 /** Push a '+' symbol onto the stack.
 221                  */
 222                 void PushPlus();
 223
 224                 /** Push a '-' symbol onto the stack.
 225                  */
 226                 void PushMinus();
 227
 228                 /** Return zero or more elements which form the
 229                  * mode line. This will be clamped to a max of
 230                  * MAXMODES items (MAXMODES-1 mode parameters and
 231                  * one mode sequence string), and max_line_size
 232                  * characters. As specified below, this function
 233                  * should be called in a loop until it returns zero,
 234                  * indicating there are no more modes to return.
 235                  * @param result The vector to populate. This will not
 236                  * be cleared before it is used.
 237                  * @param max_line_size The maximum size of the line
 238                  * to build, in characters, seperate to MAXMODES.
 239                  * @return The number of elements in the deque.
 240                  * The function should be called repeatedly until it
 241                  * returns 0, in case there are multiple lines of
 242                  * mode changes to be obtained.
 243                  */
 244                 int GetStackedLine(std::vector<std::string> &result, int max_line_size = 360);
 245
 246         };
 247
 248         /** irc::sepstream allows for splitting token seperated lists.
 249          * Each successive call to sepstream::GetToken() returns
 250          * the next token, until none remain, at which point the method returns
 251          * an empty string.
 252          */
 253         class CoreExport sepstream
 254         {
 255          protected:
 256                 /** Original string.
 257                  */
 258                 std::string tokens;
 259                 /** Separator value
 260                  */
 261                 char sep;
 262                 /** Current string position
 263                  */
 264                 size_t pos;
 265                 /** If set then GetToken() can return an empty string
 266                  */
 267                 bool allow_empty;
 268          public:
 269                 /** Create a sepstream and fill it with the provided data
 270                  */
 271                 sepstream(const std::string &source, char separator, bool allowempty = false);
 272
 273                 /** Fetch the next token from the stream
 274                  * @param token The next token from the stream is placed here
 275                  * @return True if tokens still remain, false if there are none left
 276                  */
 277                 bool GetToken(std::string& token);
 278
 279                 /** Fetch the entire remaining stream, without tokenizing
 280                  * @return The remaining part of the stream
 281                  */
 282                 const std::string GetRemaining();
 283
 284                 /** Returns true if the end of the stream has been reached
 285                  * @return True if the end of the stream has been reached, otherwise false
 286                  */
 287                 bool StreamEnd();
 288         };
 289
 290         /** A derived form of sepstream, which seperates on commas
 291          */
 292         class CoreExport commasepstream : public sepstream
 293         {
 294          public:
 295                 /** Initialize with comma separator
 296                  */
 297                 commasepstream(const std::string &source, bool allowempty = false) : sepstream(source, ',', allowempty)
 298                 {
 299                 }
 300         };
 301
 302         /** A derived form of sepstream, which seperates on spaces
 303          */
 304         class CoreExport spacesepstream : public sepstream
 305         {
 306          public:
 307                 /** Initialize with space separator
 308                  */
 309                 spacesepstream(const std::string &source, bool allowempty = false) : sepstream(source, ' ', allowempty)
 310                 {
 311                 }
 312         };
 313
 314         /** irc::tokenstream reads a string formatted as per RFC1459 and RFC2812.
 315          * It will split the string into 'tokens' each containing one parameter
 316          * from the string.
 317          * For instance, if it is instantiated with the string:
 318          * "PRIVMSG #test :foo bar baz qux"
 319          * then each successive call to tokenstream::GetToken() will return
 320          * "PRIVMSG", "#test", "foo bar baz qux", "".
 321          * Note that if the whole string starts with a colon this is not taken
 322          * to mean the string is all one parameter, and the first item in the
 323          * list will be ":item". This is to allow for parsing 'source' fields
 324          * from data.
 325          */
 326         class CoreExport tokenstream : private spacesepstream
 327         {
 328          public:
 329                 /** Create a tokenstream and fill it with the provided data
 330                  */
 331                 tokenstream(const std::string &source);
 332
 333                 /** Fetch the next token from the stream as a std::string
 334                  * @param token The next token available, or an empty string if none remain
 335                  * @return True if tokens are left to be read, false if the last token was just retrieved.
 336                  */
 337                 bool GetToken(std::string &token);
 338
 339                 /** Fetch the next token from the stream as an irc::string
 340                  * @param token The next token available, or an empty string if none remain
 341                  * @return True if tokens are left to be read, false if the last token was just retrieved.
 342                  */
 343                 bool GetToken(irc::string &token);
 344
 345                 /** Fetch the next token from the stream as an integer
 346                  * @param token The next token available, or undefined if none remain
 347                  * @return True if tokens are left to be read, false if the last token was just retrieved.
 348                  */
 349                 bool GetToken(int &token);
 350
 351                 /** Fetch the next token from the stream as a long integer
 352                  * @param token The next token available, or undefined if none remain
 353                  * @return True if tokens are left to be read, false if the last token was just retrieved.
 354                  */
 355                 bool GetToken(long &token);
 356         };
 357
 358         /** The portparser class seperates out a port range into integers.
 359          * A port range may be specified in the input string in the form
 360          * "6660,6661,6662-6669,7020". The end of the stream is indicated by
 361          * a return value of 0 from portparser::GetToken(). If you attempt
 362          * to specify an illegal range (e.g. one where start >= end, or
 363          * start or end < 0) then GetToken() will return the first element
 364          * of the pair of numbers.
 365          */
 366         class CoreExport portparser
 367         {
 368          private:
 369
 370                 /** Used to split on commas
 371                  */
 372                 commasepstream sep;
 373
 374                 /** Current position in a range of ports
 375                  */
 376                 long in_range;
 377
 378                 /** Starting port in a range of ports
 379                  */
 380                 long range_begin;
 381
 382                 /** Ending port in a range of ports
 383                  */
 384                 long range_end;
 385
 386                 /** Allow overlapped port ranges
 387                  */
 388                 bool overlapped;
 389
 390                 /** Used to determine overlapping of ports
 391                  * without O(n) algorithm being used
 392                  */
 393                 std::set<long> overlap_set;
 394
 395                 /** Returns true if val overlaps an existing range
 396                  */
 397                 bool Overlaps(long val);
 398          public:
 399
 400                 /** Create a portparser and fill it with the provided data
 401                  * @param source The source text to parse from
 402                  * @param allow_overlapped Allow overlapped ranges
 403                  */
 404                 portparser(const std::string &source, bool allow_overlapped = true);
 405
 406                 /** Fetch the next token from the stream
 407                  * @return The next port number is returned, or 0 if none remain
 408                  */
 409                 long GetToken();
 410         };
 411
 412         struct hash
 413         {
 414                 /** Hash an irc::string using RFC1459 case sensitivity rules
 415                  * @param s A string to hash
 416                  * @return The hash value
 417                  */
 418                 size_t CoreExport operator()(const irc::string &s) const;
 419         };
 420 }
 421
 422 /* Define operators for using >> and << with irc::string to an ostream on an istream. */
 423 /* This was endless fun. No. Really. */
 424 /* It was also the first core change Ommeh made, if anyone cares */
 425
 426 /** Operator << for irc::string
 427  */
 428 inline std::ostream& operator<<(std::ostream &os, const irc::string &str) { return os << str.c_str(); }
 429
 430 /** Operator >> for irc::string
 431  */
 432 inline std::istream& operator>>(std::istream &is, irc::string &str)
 433 {
 434         std::string tmp;
 435         is >> tmp;
 436         str = tmp.c_str();
 437         return is;
 438 }
 439
 440 /* Define operators for + and == with irc::string to std::string for easy assignment
 441  * and comparison
 442  *
 443  * Operator +
 444  */
 445 inline std::string operator+ (std::string& leftval, irc::string& rightval)
 446 {
 447         return leftval + std::string(rightval.c_str());
 448 }
 449
 450 /* Define operators for + and == with irc::string to std::string for easy assignment
 451  * and comparison
 452  *
 453  * Operator +
 454  */
 455 inline irc::string operator+ (irc::string& leftval, std::string& rightval)
 456 {
 457         return leftval + irc::string(rightval.c_str());
 458 }
 459
 460 /* Define operators for + and == with irc::string to std::string for easy assignment
 461  * and comparison
 462  *
 463  * Operator ==
 464  */
 465 inline bool operator== (const std::string& leftval, const irc::string& rightval)
 466 {
 467         return (leftval.c_str() == rightval);
 468 }
 469
 470 /* Define operators for + and == with irc::string to std::string for easy assignment
 471  * and comparison
 472  *
 473  * Operator ==
 474  */
 475 inline bool operator== (const irc::string& leftval, const std::string& rightval)
 476 {
 477         return (leftval == rightval.c_str());
 478 }
 479
 480 /* Define operators != for irc::string to std::string for easy comparison
 481  */
 482 inline bool operator!= (const irc::string& leftval, const std::string& rightval)
 483 {
 484         return !(leftval == rightval.c_str());
 485 }
 486
 487 /* Define operators != for std::string to irc::string for easy comparison
 488  */
 489 inline bool operator!= (const std::string& leftval, const irc::string& rightval)
 490 {
 491         return !(leftval.c_str() == rightval);
 492 }
 493
 494 /** Assign an irc::string to a std::string.
 495  */
 496 inline std::string assign(const irc::string &other) { return other.c_str(); }
 497
 498 /** Assign a std::string to an irc::string.
 499  */
 500 inline irc::string assign(const std::string &other) { return other.c_str(); }
 501
 502 /** Trim the leading and trailing spaces from a std::string.
 503  */
 504 inline std::string& trim(std::string &str)
 505 {
 506         std::string::size_type start = str.find_first_not_of(" ");
 507         std::string::size_type end = str.find_last_not_of(" ");
 508         if (start == std::string::npos || end == std::string::npos)
 509                 str = "";
 510         else
 511                 str = str.substr(start, end-start+1);
 512
 513         return str;
 514 }