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