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         /** The irc_char_traits class is used for RFC-style comparison of strings.
 118          * This class is used to implement irc::string, a case-insensitive, RFC-
 119          * comparing string class.
 120          */
 121         struct CoreExport irc_char_traits : public std::char_traits<char>
 122         {
 123                 /** Check if two chars match.
 124                  * @param c1st First character
 125                  * @param c2nd Second character
 126                  * @return true if the characters are equal
 127                  */
 128                 static bool eq(char c1st, char c2nd);
 129
 130                 /** Check if two chars do NOT match.
 131                  * @param c1st First character
 132                  * @param c2nd Second character
 133                  * @return true if the characters are unequal
 134                  */
 135                 static bool ne(char c1st, char c2nd);
 136
 137                 /** Check if one char is less than another.
 138                  * @param c1st First character
 139                  * @param c2nd Second character
 140                  * @return true if c1st is less than c2nd
 141                  */
 142                 static bool lt(char c1st, char c2nd);
 143
 144                 /** Compare two strings of size n.
 145                  * @param str1 First string
 146                  * @param str2 Second string
 147                  * @param n Length to compare to
 148                  * @return similar to strcmp, zero for equal, less than zero for str1
 149                  * being less and greater than zero for str1 being greater than str2.
 150                  */
 151                 static CoreExport int compare(const char* str1, const char* str2, size_t n);
 152
 153                 /** Find a char within a string up to position n.
 154                  * @param s1 String to find in
 155                  * @param n Position to search up to
 156                  * @param c Character to search for
 157                  * @return Pointer to the first occurance of c in s1
 158                  */
 159                 static CoreExport const char* find(const char* s1, int  n, char c);
 160         };
 161
 162         /** This typedef declares irc::string based upon irc_char_traits.
 163          */
 164         typedef std::basic_string<char, irc_char_traits, std::allocator<char> > string;
 165
 166         /** irc::stringjoiner joins string lists into a string, using
 167          * space as the separator.
 168          * This class can join a vector of std::string.
 169          */
 170         class CoreExport stringjoiner
 171         {
 172          private:
 173
 174                 /** Output string
 175                  */
 176                 std::string joined;
 177
 178          public:
 179
 180                 /** Join all elements of a vector, in the resulting string
 181                  * each element will be seperated by a single space character.
 182                  * @param sequence Zero or more items to seperate
 183                  */
 184                 stringjoiner(const std::vector<std::string>& sequence);
 185
 186                 /** Get the joined sequence
 187                  * @return A constant reference to the joined string
 188                  */
 189                 const std::string& GetJoined() const { return joined; }
 190         };
 191
 192         /** irc::modestacker stacks mode sequences into a list.
 193          * It can then reproduce this list, clamped to a maximum of MAXMODES
 194          * values per line.
 195          */
 196         class CoreExport modestacker
 197         {
 198          private:
 199                 /** The mode sequence and its parameters
 200                  */
 201                 std::deque<std::string> sequence;
 202
 203                 /** True if the mode sequence is initially adding
 204                  * characters, false if it is initially removing
 205                  * them
 206                  */
 207                 bool adding;
 208          public:
 209
 210                 /** Construct a new modestacker.
 211                  * @param add True if the stack is adding modes,
 212                  * false if it is removing them
 213                  */
 214                 modestacker(bool add);
 215
 216                 /** Push a modeletter and its parameter onto the stack.
 217                  * No checking is performed as to if this mode actually
 218                  * requires a parameter. If you stack invalid mode
 219                  * sequences, they will be tidied if and when they are
 220                  * passed to a mode parser.
 221                  * @param modeletter The mode letter to insert
 222                  * @param parameter The parameter for the mode
 223                  */
 224                 void Push(char modeletter, const std::string &parameter);
 225
 226                 /** Push a modeletter without parameter onto the stack.
 227                  * No checking is performed as to if this mode actually
 228                  * requires a parameter. If you stack invalid mode
 229                  * sequences, they will be tidied if and when they are
 230                  * passed to a mode parser.
 231                  * @param modeletter The mode letter to insert
 232                  */
 233                 void Push(char modeletter);
 234
 235                 /** Push a '+' symbol onto the stack.
 236                  */
 237                 void PushPlus();
 238
 239                 /** Push a '-' symbol onto the stack.
 240                  */
 241                 void PushMinus();
 242
 243                 /** Return zero or more elements which form the
 244                  * mode line. This will be clamped to a max of
 245                  * MAXMODES items (MAXMODES-1 mode parameters and
 246                  * one mode sequence string), and max_line_size
 247                  * characters. As specified below, this function
 248                  * should be called in a loop until it returns zero,
 249                  * indicating there are no more modes to return.
 250                  * @param result The vector to populate. This will not
 251                  * be cleared before it is used.
 252                  * @param max_line_size The maximum size of the line
 253                  * to build, in characters, seperate to MAXMODES.
 254                  * @return The number of elements in the deque.
 255                  * The function should be called repeatedly until it
 256                  * returns 0, in case there are multiple lines of
 257                  * mode changes to be obtained.
 258                  */
 259                 int GetStackedLine(std::vector<std::string> &result, int max_line_size = 360);
 260
 261         };
 262
 263         /** irc::sepstream allows for splitting token seperated lists.
 264          * Each successive call to sepstream::GetToken() returns
 265          * the next token, until none remain, at which point the method returns
 266          * an empty string.
 267          */
 268         class CoreExport sepstream
 269         {
 270          protected:
 271                 /** Original string.
 272                  */
 273                 std::string tokens;
 274                 /** Separator value
 275                  */
 276                 char sep;
 277                 /** Current string position
 278                  */
 279                 size_t pos;
 280                 /** If set then GetToken() can return an empty string
 281                  */
 282                 bool allow_empty;
 283          public:
 284                 /** Create a sepstream and fill it with the provided data
 285                  */
 286                 sepstream(const std::string &source, char separator, bool allowempty = false);
 287
 288                 /** Fetch the next token from the stream
 289                  * @param token The next token from the stream is placed here
 290                  * @return True if tokens still remain, false if there are none left
 291                  */
 292                 bool GetToken(std::string& token);
 293
 294                 /** Fetch the entire remaining stream, without tokenizing
 295                  * @return The remaining part of the stream
 296                  */
 297                 const std::string GetRemaining();
 298
 299                 /** Returns true if the end of the stream has been reached
 300                  * @return True if the end of the stream has been reached, otherwise false
 301                  */
 302                 bool StreamEnd();
 303         };
 304
 305         /** A derived form of sepstream, which seperates on commas
 306          */
 307         class CoreExport commasepstream : public sepstream
 308         {
 309          public:
 310                 /** Initialize with comma separator
 311                  */
 312                 commasepstream(const std::string &source, bool allowempty = false) : sepstream(source, ',', allowempty)
 313                 {
 314                 }
 315         };
 316
 317         /** A derived form of sepstream, which seperates on spaces
 318          */
 319         class CoreExport spacesepstream : public sepstream
 320         {
 321          public:
 322                 /** Initialize with space separator
 323                  */
 324                 spacesepstream(const std::string &source, bool allowempty = false) : sepstream(source, ' ', allowempty)
 325                 {
 326                 }
 327         };
 328
 329         /** irc::tokenstream reads a string formatted as per RFC1459 and RFC2812.
 330          * It will split the string into 'tokens' each containing one parameter
 331          * from the string.
 332          * For instance, if it is instantiated with the string:
 333          * "PRIVMSG #test :foo bar baz qux"
 334          * then each successive call to tokenstream::GetToken() will return
 335          * "PRIVMSG", "#test", "foo bar baz qux", "".
 336          * Note that if the whole string starts with a colon this is not taken
 337          * to mean the string is all one parameter, and the first item in the
 338          * list will be ":item". This is to allow for parsing 'source' fields
 339          * from data.
 340          */
 341         class CoreExport tokenstream : private spacesepstream
 342         {
 343          public:
 344                 /** Create a tokenstream and fill it with the provided data
 345                  */
 346                 tokenstream(const std::string &source);
 347
 348                 /** Fetch the next token from the stream as a std::string
 349                  * @param token The next token available, or an empty string if none remain
 350                  * @return True if tokens are left to be read, false if the last token was just retrieved.
 351                  */
 352                 bool GetToken(std::string &token);
 353
 354                 /** Fetch the next token from the stream as an irc::string
 355                  * @param token The next token available, or an empty string if none remain
 356                  * @return True if tokens are left to be read, false if the last token was just retrieved.
 357                  */
 358                 bool GetToken(irc::string &token);
 359
 360                 /** Fetch the next token from the stream as an integer
 361                  * @param token The next token available, or undefined if none remain
 362                  * @return True if tokens are left to be read, false if the last token was just retrieved.
 363                  */
 364                 bool GetToken(int &token);
 365
 366                 /** Fetch the next token from the stream as a long integer
 367                  * @param token The next token available, or undefined if none remain
 368                  * @return True if tokens are left to be read, false if the last token was just retrieved.
 369                  */
 370                 bool GetToken(long &token);
 371         };
 372
 373         /** The portparser class seperates out a port range into integers.
 374          * A port range may be specified in the input string in the form
 375          * "6660,6661,6662-6669,7020". The end of the stream is indicated by
 376          * a return value of 0 from portparser::GetToken(). If you attempt
 377          * to specify an illegal range (e.g. one where start >= end, or
 378          * start or end < 0) then GetToken() will return the first element
 379          * of the pair of numbers.
 380          */
 381         class CoreExport portparser
 382         {
 383          private:
 384
 385                 /** Used to split on commas
 386                  */
 387                 commasepstream sep;
 388
 389                 /** Current position in a range of ports
 390                  */
 391                 long in_range;
 392
 393                 /** Starting port in a range of ports
 394                  */
 395                 long range_begin;
 396
 397                 /** Ending port in a range of ports
 398                  */
 399                 long range_end;
 400
 401                 /** Allow overlapped port ranges
 402                  */
 403                 bool overlapped;
 404
 405                 /** Used to determine overlapping of ports
 406                  * without O(n) algorithm being used
 407                  */
 408                 std::set<long> overlap_set;
 409
 410                 /** Returns true if val overlaps an existing range
 411                  */
 412                 bool Overlaps(long val);
 413          public:
 414
 415                 /** Create a portparser and fill it with the provided data
 416                  * @param source The source text to parse from
 417                  * @param allow_overlapped Allow overlapped ranges
 418                  */
 419                 portparser(const std::string &source, bool allow_overlapped = true);
 420
 421                 /** Fetch the next token from the stream
 422                  * @return The next port number is returned, or 0 if none remain
 423                  */
 424                 long GetToken();
 425         };
 426
 427         struct hash
 428         {
 429                 /** Hash an irc::string using RFC1459 case sensitivity rules
 430                  * @param s A string to hash
 431                  * @return The hash value
 432                  */
 433                 size_t CoreExport operator()(const irc::string &s) const;
 434         };
 435 }
 436
 437 /* Define operators for using >> and << with irc::string to an ostream on an istream. */
 438 /* This was endless fun. No. Really. */
 439 /* It was also the first core change Ommeh made, if anyone cares */
 440
 441 /** Operator << for irc::string
 442  */
 443 inline std::ostream& operator<<(std::ostream &os, const irc::string &str) { return os << str.c_str(); }
 444
 445 /** Operator >> for irc::string
 446  */
 447 inline std::istream& operator>>(std::istream &is, irc::string &str)
 448 {
 449         std::string tmp;
 450         is >> tmp;
 451         str = tmp.c_str();
 452         return is;
 453 }
 454
 455 /* Define operators for + and == with irc::string to std::string for easy assignment
 456  * and comparison
 457  *
 458  * Operator +
 459  */
 460 inline std::string operator+ (std::string& leftval, irc::string& rightval)
 461 {
 462         return leftval + std::string(rightval.c_str());
 463 }
 464
 465 /* Define operators for + and == with irc::string to std::string for easy assignment
 466  * and comparison
 467  *
 468  * Operator +
 469  */
 470 inline irc::string operator+ (irc::string& leftval, std::string& rightval)
 471 {
 472         return leftval + irc::string(rightval.c_str());
 473 }
 474
 475 /* Define operators for + and == with irc::string to std::string for easy assignment
 476  * and comparison
 477  *
 478  * Operator ==
 479  */
 480 inline bool operator== (const std::string& leftval, const irc::string& rightval)
 481 {
 482         return (leftval.c_str() == rightval);
 483 }
 484
 485 /* Define operators for + and == with irc::string to std::string for easy assignment
 486  * and comparison
 487  *
 488  * Operator ==
 489  */
 490 inline bool operator== (const irc::string& leftval, const std::string& rightval)
 491 {
 492         return (leftval == rightval.c_str());
 493 }
 494
 495 /* Define operators != for irc::string to std::string for easy comparison
 496  */
 497 inline bool operator!= (const irc::string& leftval, const std::string& rightval)
 498 {
 499         return !(leftval == rightval.c_str());
 500 }
 501
 502 /* Define operators != for std::string to irc::string for easy comparison
 503  */
 504 inline bool operator!= (const std::string& leftval, const irc::string& rightval)
 505 {
 506         return !(leftval.c_str() == rightval);
 507 }
 508
 509 /** Assign an irc::string to a std::string.
 510  */
 511 inline std::string assign(const irc::string &other) { return other.c_str(); }
 512
 513 /** Assign a std::string to an irc::string.
 514  */
 515 inline irc::string assign(const std::string &other) { return other.c_str(); }
 516
 517 /** Trim the leading and trailing spaces from a std::string.
 518  */
 519 inline std::string& trim(std::string &str)
 520 {
 521         std::string::size_type start = str.find_first_not_of(" ");
 522         std::string::size_type end = str.find_last_not_of(" ");
 523         if (start == std::string::npos || end == std::string::npos)
 524                 str = "";
 525         else
 526                 str = str.substr(start, end-start+1);
 527
 528         return str;
 529 }