1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2008 InspIRCd Development Team
6 * See: http://www.inspircd.org/wiki/index.php/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
17 //#include "inspircd_config.h"
21 /*******************************************************
22 * This file contains classes and templates that deal
23 * with the comparison and hashing of 'irc strings'.
24 * An 'irc string' is a string which compares in a
25 * case insensitive manner, and as per RFC 1459 will
26 * treat [ identical to {, ] identical to }, and \
29 * Our hashing functions are designed to accept
30 * std::string and compare/hash them as type irc::string
31 * by converting them internally. This makes them
32 * backwards compatible with other code which is not
33 * aware of irc::string.
34 *******************************************************/
38 /** A mapping of uppercase to lowercase, including scandinavian
39 * 'oddities' as specified by RFC1459, e.g. { -> [, and | -> \
41 unsigned const char lowermap[256] = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, /* 0-19 */
42 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, /* 20-39 */
43 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, /* 40-59 */
44 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, /* 60-79 */
45 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 94, 95, 96, 97, 98, 99, /* 80-99 */
46 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, /* 100-119 */
47 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, /* 120-139 */
48 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, /* 140-159 */
49 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, /* 160-179 */
50 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, /* 180-199 */
51 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, /* 200-219 */
52 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, /* 220-239 */
53 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254, 255 /* 240-255 */
57 /** The irc namespace contains a number of helper classes.
62 /** This class returns true if two strings match.
63 * Case sensitivity is ignored, and the RFC 'character set'
68 /** The operator () does the actual comparison in hash_map
70 bool operator()(const std::string& s1, const std::string& s2) const;
73 /** The irc_char_traits class is used for RFC-style comparison of strings.
74 * This class is used to implement irc::string, a case-insensitive, RFC-
75 * comparing string class.
77 struct irc_char_traits : std::char_traits<char> {
79 /** Check if two chars match.
80 * @param c1st First character
81 * @param c2nd Second character
82 * @return true if the characters are equal
84 static bool eq(char c1st, char c2nd);
86 /** Check if two chars do NOT match.
87 * @param c1st First character
88 * @param c2nd Second character
89 * @return true if the characters are unequal
91 static bool ne(char c1st, char c2nd);
93 /** Check if one char is less than another.
94 * @param c1st First character
95 * @param c2nd Second character
96 * @return true if c1st is less than c2nd
98 static bool lt(char c1st, char c2nd);
100 /** Compare two strings of size n.
101 * @param str1 First string
102 * @param str2 Second string
103 * @param n Length to compare to
104 * @return similar to strcmp, zero for equal, less than zero for str1
105 * being less and greater than zero for str1 being greater than str2.
107 static CoreExport int compare(const char* str1, const char* str2, size_t n);
109 /** Find a char within a string up to position n.
110 * @param s1 String to find in
111 * @param n Position to search up to
112 * @param c Character to search for
113 * @return Pointer to the first occurance of c in s1
115 static CoreExport const char* find(const char* s1, int n, char c);
118 /** Compose a hex string from raw data.
119 * @param raw The raw data to compose hex from
120 * @pram rawsz The size of the raw data buffer
121 * @return The hex string.
123 CoreExport std::string hex(const unsigned char *raw, size_t rawsz);
125 /** This typedef declares irc::string based upon irc_char_traits.
127 typedef std::basic_string<char, irc_char_traits, std::allocator<char> > string;
129 /** irc::stringjoiner joins string lists into a string, using
130 * the given seperator string.
131 * This class can join a vector of std::string, a deque of
132 * std::string, or a const char* const* array, using overloaded
135 class CoreExport stringjoiner : public classbase
142 /** Join elements of a vector, between (and including) begin and end
143 * @param seperator The string to seperate values with
144 * @param sequence One or more items to seperate
145 * @param begin The starting element in the sequence to be joined
146 * @param end The ending element in the sequence to be joined
148 stringjoiner(const std::string &seperator, const std::vector<std::string> &sequence, int begin, int end);
149 /** Join elements of a deque, between (and including) begin and end
150 * @param seperator The string to seperate values with
151 * @param sequence One or more items to seperate
152 * @param begin The starting element in the sequence to be joined
153 * @param end The ending element in the sequence to be joined
155 stringjoiner(const std::string &seperator, const std::deque<std::string> &sequence, int begin, int end);
156 /** Join elements of an array of char arrays, between (and including) begin and end
157 * @param seperator The string to seperate values with
158 * @param sequence One or more items to seperate
159 * @param begin The starting element in the sequence to be joined
160 * @param end The ending element in the sequence to be joined
162 stringjoiner(const std::string &seperator, const char* const* sequence, int begin, int end);
164 /** Get the joined sequence
165 * @return A reference to the joined string
167 std::string& GetJoined();
170 /** irc::modestacker stacks mode sequences into a list.
171 * It can then reproduce this list, clamped to a maximum of MAXMODES
174 class CoreExport modestacker : public classbase
177 /** The mode sequence and its parameters
179 std::deque<std::string> sequence;
180 /** True if the mode sequence is initially adding
181 * characters, false if it is initially removing
186 /** Construct a new modestacker.
187 * @param add True if the stack is adding modes,
188 * false if it is removing them
190 modestacker(bool add);
191 /** Push a modeletter and its parameter onto the stack.
192 * No checking is performed as to if this mode actually
193 * requires a parameter. If you stack invalid mode
194 * sequences, they will be tidied if and when they are
195 * passed to a mode parser.
196 * @param modeletter The mode letter to insert
197 * @param parameter The parameter for the mode
199 void Push(char modeletter, const std::string ¶meter);
200 /** Push a modeletter without parameter onto the stack.
201 * No checking is performed as to if this mode actually
202 * requires a parameter. If you stack invalid mode
203 * sequences, they will be tidied if and when they are
204 * passed to a mode parser.
205 * @param modeletter The mode letter to insert
207 void Push(char modeletter);
208 /** Push a '+' symbol onto the stack.
211 /** Push a '-' symbol onto the stack.
214 /** Return zero or more elements which form the
215 * mode line. This will be clamped to a max of
216 * MAXMODES items (MAXMODES-1 mode parameters and
217 * one mode sequence string), and max_line_size
218 * characters. As specified below, this function
219 * should be called in a loop until it returns zero,
220 * indicating there are no more modes to return.
221 * @param result The deque to populate. This will
222 * be cleared before it is used.
223 * @param max_line_size The maximum size of the line
224 * to build, in characters, seperate to MAXMODES.
225 * @return The number of elements in the deque.
226 * The function should be called repeatedly until it
227 * returns 0, in case there are multiple lines of
228 * mode changes to be obtained.
230 int GetStackedLine(std::deque<std::string> &result, int max_line_size = 360);
233 /** irc::tokenstream reads a string formatted as per RFC1459 and RFC2812.
234 * It will split the string into 'tokens' each containing one parameter
236 * For instance, if it is instantiated with the string:
237 * "PRIVMSG #test :foo bar baz qux"
238 * then each successive call to tokenstream::GetToken() will return
239 * "PRIVMSG", "#test", "foo bar baz qux", "".
240 * Note that if the whole string starts with a colon this is not taken
241 * to mean the string is all one parameter, and the first item in the
242 * list will be ":item". This is to allow for parsing 'source' fields
245 class CoreExport tokenstream : public classbase
251 /** Last position of a seperator token
253 std::string::iterator last_starting_position;
254 /** Current string position
256 std::string::iterator n;
257 /** True if the last value was an ending value
261 /** Create a tokenstream and fill it with the provided data
263 tokenstream(const std::string &source);
266 /** Fetch the next token from the stream as a std::string
267 * @param token The next token available, or an empty string if none remain
268 * @return True if tokens are left to be read, false if the last token was just retrieved.
270 bool GetToken(std::string &token);
272 /** Fetch the next token from the stream as an irc::string
273 * @param token The next token available, or an empty string if none remain
274 * @return True if tokens are left to be read, false if the last token was just retrieved.
276 bool GetToken(irc::string &token);
278 /** Fetch the next token from the stream as an integer
279 * @param token The next token available, or undefined if none remain
280 * @return True if tokens are left to be read, false if the last token was just retrieved.
282 bool GetToken(int &token);
284 /** Fetch the next token from the stream as a long integer
285 * @param token The next token available, or undefined if none remain
286 * @return True if tokens are left to be read, false if the last token was just retrieved.
288 bool GetToken(long &token);
291 /** irc::sepstream allows for splitting token seperated lists.
292 * Each successive call to sepstream::GetToken() returns
293 * the next token, until none remain, at which point the method returns
296 class CoreExport sepstream : public classbase
302 /** Last position of a seperator token
304 std::string::iterator last_starting_position;
305 /** Current string position
307 std::string::iterator n;
312 /** Create a sepstream and fill it with the provided data
314 sepstream(const std::string &source, char seperator);
315 virtual ~sepstream();
317 /** Fetch the next token from the stream
318 * @param token The next token from the stream is placed here
319 * @return True if tokens still remain, false if there are none left
321 virtual bool GetToken(std::string &token);
323 /** Fetch the entire remaining stream, without tokenizing
324 * @return The remaining part of the stream
326 virtual const std::string GetRemaining();
328 /** Returns true if the end of the stream has been reached
329 * @return True if the end of the stream has been reached, otherwise false
331 virtual bool StreamEnd();
334 /** A derived form of sepstream, which seperates on commas
336 class CoreExport commasepstream : public sepstream
339 /** Initialize with comma seperator
341 commasepstream(const std::string &source) : sepstream(source, ',')
346 /** A derived form of sepstream, which seperates on spaces
348 class CoreExport spacesepstream : public sepstream
351 /** Initialize with space seperator
353 spacesepstream(const std::string &source) : sepstream(source, ' ')
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.
366 class CoreExport portparser : public classbase
369 /** Used to split on commas
372 /** Current position in a range of ports
375 /** Starting port in a range of ports
378 /** Ending port in a range of ports
381 /** Allow overlapped port ranges
384 /** Used to determine overlapping of ports
385 * without O(n) algorithm being used
387 std::map<long, bool> overlap_set;
388 /** Returns true if val overlaps an existing range
390 bool Overlaps(long val);
392 /** Create a portparser and fill it with the provided data
393 * @param source The source text to parse from
394 * @param allow_overlapped Allow overlapped ranges
396 portparser(const std::string &source, bool allow_overlapped = true);
397 /** Frees the internal commasepstream object
400 /** Fetch the next token from the stream
401 * @return The next port number is returned, or 0 if none remain
406 /** Used to hold a bitfield definition in dynamicbitmask.
407 * You must be allocated one of these by dynamicbitmask::Allocate(),
408 * you should not fill the values yourself!
410 typedef std::pair<size_t, unsigned char> bitfield;
412 /** The irc::dynamicbitmask class is used to maintain a bitmap of
413 * boolean values, which can grow to any reasonable size no matter
414 * how many bitfields are in it.
416 * It starts off at 32 bits in size, large enough to hold 32 boolean
417 * values, with a memory allocation of 8 bytes. If you allocate more
418 * than 32 bits, the class will grow the bitmap by 8 bytes at a time
419 * for each set of 8 bitfields you allocate with the Allocate()
422 * This method is designed so that multiple modules can be allocated
423 * bit values in a bitmap dynamically, rather than having to define
424 * costs in a fixed size unsigned integer and having the possibility
425 * of collisions of values in different third party modules.
429 * To use this class, you must derive from it.
430 * This is because each derived instance has its own freebits array
431 * which can determine what bitfields are allocated on a TYPE BY TYPE
432 * basis, e.g. an irc::dynamicbitmask type for Users, and one for
433 * Channels, etc. You should inheret it in a very simple way as follows.
434 * The base class will resize and maintain freebits as required, you are
435 * just required to make the pointer static and specific to this class
439 * class mydbitmask : public irc::dynamicbitmask
443 * static unsigned char* freebits;
447 * mydbitmask() : irc::dynamicbitmask()
449 * freebits = new unsigned char[this->bits_size];
450 * memset(freebits, 0, this->bits_size);
458 * unsigned char* GetFreeBits()
463 * void SetFreeBits(unsigned char* freebt)
470 class CoreExport dynamicbitmask : public classbase
473 /** Data bits. We start with four of these,
474 * and we grow the bitfield as we allocate
475 * more than 32 entries with Allocate().
479 /** Current set size (size of freebits and bits).
480 * Both freebits and bits will ALWAYS be the
483 unsigned char bits_size;
485 /** Allocate the initial memory for bits and
486 * freebits and zero the memory.
490 /** Free the memory used by bits and freebits
492 virtual ~dynamicbitmask();
494 /** Allocate an irc::bitfield.
495 * @return An irc::bitfield which can be used
496 * with Get, Deallocate and Toggle methods.
497 * @throw Can throw std::bad_alloc if there is
498 * no ram left to grow the bitmask.
502 /** Deallocate an irc::bitfield.
503 * @param An irc::bitfield to deallocate.
504 * @return True if the bitfield could be
505 * deallocated, false if it could not.
507 bool Deallocate(bitfield &pos);
509 /** Toggle the value of a bitfield.
510 * @param pos A bitfield to allocate, previously
511 * allocated by dyamicbitmask::Allocate().
512 * @param state The state to set the field to.
514 void Toggle(bitfield &pos, bool state);
516 /** Get the value of a bitfield.
517 * @param pos A bitfield to retrieve, previously
518 * allocated by dyamicbitmask::Allocate().
519 * @return The value of the bitfield.
520 * @throw Will throw ModuleException if the bitfield
521 * you provide is outside of the range
522 * 0 >= bitfield.first < size_bits.
524 bool Get(bitfield &pos);
526 /** Return the size in bytes allocated to the bits
528 * Note that the actual allocation is twice this,
529 * as there are an equal number of bytes allocated
530 * for the freebits array.
532 unsigned char GetSize();
534 /** Get free bits mask
536 virtual unsigned char* GetFreeBits() { return NULL; }
538 /** Set free bits mask
540 virtual void SetFreeBits(unsigned char* freebits) { freebits = freebits; }
543 /** Turn _ characters in a string into spaces
544 * @param n String to translate
545 * @return The new value with _ translated to space.
547 CoreExport const char* Spacify(const char* n);
550 /* Define operators for using >> and << with irc::string to an ostream on an istream. */
551 /* This was endless fun. No. Really. */
552 /* It was also the first core change Ommeh made, if anyone cares */
554 /** Operator << for irc::string
556 inline std::ostream& operator<<(std::ostream &os, const irc::string &str) { return os << str.c_str(); }
558 /** Operator >> for irc::string
560 inline std::istream& operator>>(std::istream &is, irc::string &str)
568 /* Define operators for + and == with irc::string to std::string for easy assignment
573 inline std::string operator+ (std::string& leftval, irc::string& rightval)
575 return leftval + std::string(rightval.c_str());
578 /* Define operators for + and == with irc::string to std::string for easy assignment
583 inline irc::string operator+ (irc::string& leftval, std::string& rightval)
585 return leftval + irc::string(rightval.c_str());
588 /* Define operators for + and == with irc::string to std::string for easy assignment
593 inline bool operator== (const std::string& leftval, const irc::string& rightval)
595 return (leftval.c_str() == rightval);
598 /* Define operators for + and == with irc::string to std::string for easy assignment
603 inline bool operator== (const irc::string& leftval, const std::string& rightval)
605 return (leftval == rightval.c_str());
608 /* Define operators != for irc::string to std::string for easy comparison
610 inline bool operator!= (const irc::string& leftval, const std::string& rightval)
612 return !(leftval == rightval.c_str());
615 /* Define operators != for std::string to irc::string for easy comparison
617 inline bool operator!= (const std::string& leftval, const irc::string& rightval)
619 return !(leftval.c_str() == rightval);
622 /** Assign an irc::string to a std::string.
624 inline std::string assign(const irc::string &other) { return other.c_str(); }
626 /** Assign a std::string to an irc::string.
628 inline irc::string assign(const std::string &other) { return other.c_str(); }
630 /** Trim the leading and trailing spaces from a std::string.
632 inline std::string& trim(std::string &str)
634 std::string::size_type start = str.find_first_not_of(" ");
635 std::string::size_type end = str.find_last_not_of(" ");
636 if (start == std::string::npos || end == std::string::npos)
639 str = str.substr(start, end-start+1);
644 /** Hashing stuff is totally different on vc++'s hash_map implementation, so to save a buttload of
645 * #ifdefs we'll just do it all at once
649 /** Hashing function to hash irc::string
652 template<> class CoreExport hash_compare<irc::string, std::less<irc::string> >
655 enum { bucket_size = 4, min_buckets = 8 }; /* Got these numbers from the CRT source, if anyone wants to change them feel free. */
657 /** Compare two irc::string values for hashing in hash_map
659 bool operator()(const irc::string & s1, const irc::string & s2) const
661 if(s1.length() != s2.length()) return true;
662 return (irc::irc_char_traits::compare(s1.c_str(), s2.c_str(), s1.length()) < 0);
665 /** Hash an irc::string value for hash_map
667 size_t operator()(const irc::string & s) const;
670 template<> class CoreExport hash_compare<std::string, std::less<std::string> >
673 enum { bucket_size = 4, min_buckets = 8 }; /* Again, from the CRT source */
675 /** Compare two std::string values for hashing in hash_map
677 bool operator()(const std::string & s1, const std::string & s2) const
679 if(s1.length() != s2.length()) return true;
680 return (irc::irc_char_traits::compare(s1.c_str(), s2.c_str(), s1.length()) < 0);
683 /** Hash a std::string using RFC1459 case sensitivity rules
684 * @param s A string to hash
685 * @return The hash value
687 size_t operator()(const std::string & s) const;
690 template<> struct hash<irc::string>
692 /** Hash an irc::string using RFC1459 case sensitivity rules
693 * @param s A string to hash
694 * @return The hash value
696 size_t operator()(const irc::string &s) const;
699 template<> struct hash<std::string>
701 /** Hash a std::string using RFC1459 case sensitivity rules
702 * @param s A string to hash
703 * @return The hash value
705 size_t operator()(const std::string &s) const;
709 /** Convert a string to lower case respecting RFC1459
710 * @param n A string to lowercase
712 void strlower(char *n);