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 * ---------------------------------------------------
18 //#include "inspircd_config.h"
22 /*******************************************************
23 * This file contains classes and templates that deal
24 * with the comparison and hashing of 'irc strings'.
25 * An 'irc string' is a string which compares in a
26 * case insensitive manner, and as per RFC 1459 will
27 * treat [ identical to {, ] identical to }, and \
30 * Our hashing functions are designed to accept
31 * std::string and compare/hash them as type irc::string
32 * by converting them internally. This makes them
33 * backwards compatible with other code which is not
34 * aware of irc::string.
35 *******************************************************/
40 /** A mapping of uppercase to lowercase, including scandinavian
41 * 'oddities' as specified by RFC1459, e.g. { -> [, and | -> \
43 unsigned const char rfc_case_insensitive_map[256] = {
44 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, /* 0-19 */
45 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, /* 20-39 */
46 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, /* 40-59 */
47 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, /* 60-79 */
48 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 94, 95, 96, 97, 98, 99, /* 80-99 */
49 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, /* 100-119 */
50 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, /* 120-139 */
51 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, /* 140-159 */
52 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, /* 160-179 */
53 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, /* 180-199 */
54 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, /* 200-219 */
55 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, /* 220-239 */
56 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254, 255 /* 240-255 */
62 unsigned const char case_sensitive_map[256] = {
63 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20,
64 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40,
65 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60,
66 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80,
67 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100,
68 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120,
69 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140,
70 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160,
71 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180,
72 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200,
73 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220,
74 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240,
75 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254, 255
80 /** The irc namespace contains a number of helper classes.
85 /** This class returns true if two strings match.
86 * Case sensitivity is ignored, and the RFC 'character set'
91 /** The operator () does the actual comparison in hash_map
93 bool operator()(const std::string& s1, const std::string& s2) const;
96 /** The irc_char_traits class is used for RFC-style comparison of strings.
97 * This class is used to implement irc::string, a case-insensitive, RFC-
98 * comparing string class.
100 struct irc_char_traits : std::char_traits<char> {
102 /** Check if two chars match.
103 * @param c1st First character
104 * @param c2nd Second character
105 * @return true if the characters are equal
107 static bool eq(char c1st, char c2nd);
109 /** Check if two chars do NOT match.
110 * @param c1st First character
111 * @param c2nd Second character
112 * @return true if the characters are unequal
114 static bool ne(char c1st, char c2nd);
116 /** Check if one char is less than another.
117 * @param c1st First character
118 * @param c2nd Second character
119 * @return true if c1st is less than c2nd
121 static bool lt(char c1st, char c2nd);
123 /** Compare two strings of size n.
124 * @param str1 First string
125 * @param str2 Second string
126 * @param n Length to compare to
127 * @return similar to strcmp, zero for equal, less than zero for str1
128 * being less and greater than zero for str1 being greater than str2.
130 static CoreExport int compare(const char* str1, const char* str2, size_t n);
132 /** Find a char within a string up to position n.
133 * @param s1 String to find in
134 * @param n Position to search up to
135 * @param c Character to search for
136 * @return Pointer to the first occurance of c in s1
138 static CoreExport const char* find(const char* s1, int n, char c);
141 /** Compose a hex string from raw data.
142 * @param raw The raw data to compose hex from
143 * @pram rawsz The size of the raw data buffer
144 * @return The hex string.
146 CoreExport std::string hex(const unsigned char *raw, size_t rawsz);
148 /** This typedef declares irc::string based upon irc_char_traits.
150 typedef std::basic_string<char, irc_char_traits, std::allocator<char> > string;
152 /** irc::stringjoiner joins string lists into a string, using
153 * the given seperator string.
154 * This class can join a vector of std::string, a deque of
155 * std::string, or a const char* const* array, using overloaded
158 class CoreExport stringjoiner : public classbase
165 /** Join elements of a vector, between (and including) begin and end
166 * @param seperator The string to seperate values with
167 * @param sequence One or more items to seperate
168 * @param begin The starting element in the sequence to be joined
169 * @param end The ending element in the sequence to be joined
171 stringjoiner(const std::string &seperator, const std::vector<std::string> &sequence, int begin, int end);
172 /** Join elements of a deque, between (and including) begin and end
173 * @param seperator The string to seperate values with
174 * @param sequence One or more items to seperate
175 * @param begin The starting element in the sequence to be joined
176 * @param end The ending element in the sequence to be joined
178 stringjoiner(const std::string &seperator, const std::deque<std::string> &sequence, int begin, int end);
179 /** Join elements of an array of char arrays, between (and including) begin and end
180 * @param seperator The string to seperate values with
181 * @param sequence One or more items to seperate
182 * @param begin The starting element in the sequence to be joined
183 * @param end The ending element in the sequence to be joined
185 stringjoiner(const std::string &seperator, const char* const* sequence, int begin, int end);
187 /** Get the joined sequence
188 * @return A reference to the joined string
190 std::string& GetJoined();
193 /** irc::modestacker stacks mode sequences into a list.
194 * It can then reproduce this list, clamped to a maximum of MAXMODES
197 class CoreExport modestacker : public classbase
200 InspIRCd* ServerInstance;
201 /** The mode sequence and its parameters
203 std::deque<std::string> sequence;
204 /** True if the mode sequence is initially adding
205 * characters, false if it is initially removing
210 /** Construct a new modestacker.
211 * @param add True if the stack is adding modes,
212 * false if it is removing them
214 modestacker(InspIRCd* Instance, bool add);
215 /** Push a modeletter and its parameter onto the stack.
216 * No checking is performed as to if this mode actually
217 * requires a parameter. If you stack invalid mode
218 * sequences, they will be tidied if and when they are
219 * passed to a mode parser.
220 * @param modeletter The mode letter to insert
221 * @param parameter The parameter for the mode
223 void Push(char modeletter, const std::string ¶meter);
224 /** Push a modeletter without parameter onto the stack.
225 * No checking is performed as to if this mode actually
226 * requires a parameter. If you stack invalid mode
227 * sequences, they will be tidied if and when they are
228 * passed to a mode parser.
229 * @param modeletter The mode letter to insert
231 void Push(char modeletter);
232 /** Push a '+' symbol onto the stack.
235 /** Push a '-' symbol onto the stack.
238 /** Return zero or more elements which form the
239 * mode line. This will be clamped to a max of
240 * MAXMODES items (MAXMODES-1 mode parameters and
241 * one mode sequence string), and max_line_size
242 * characters. As specified below, this function
243 * should be called in a loop until it returns zero,
244 * indicating there are no more modes to return.
245 * @param result The deque to populate. This will
246 * be cleared before it is used.
247 * @param max_line_size The maximum size of the line
248 * to build, in characters, seperate to MAXMODES.
249 * @return The number of elements in the deque.
250 * The function should be called repeatedly until it
251 * returns 0, in case there are multiple lines of
252 * mode changes to be obtained.
254 int GetStackedLine(std::deque<std::string> &result, int max_line_size = 360);
257 /** irc::tokenstream reads a string formatted as per RFC1459 and RFC2812.
258 * It will split the string into 'tokens' each containing one parameter
260 * For instance, if it is instantiated with the string:
261 * "PRIVMSG #test :foo bar baz qux"
262 * then each successive call to tokenstream::GetToken() will return
263 * "PRIVMSG", "#test", "foo bar baz qux", "".
264 * Note that if the whole string starts with a colon this is not taken
265 * to mean the string is all one parameter, and the first item in the
266 * list will be ":item". This is to allow for parsing 'source' fields
269 class CoreExport tokenstream : public classbase
275 /** Last position of a seperator token
277 std::string::iterator last_starting_position;
278 /** Current string position
280 std::string::iterator n;
281 /** True if the last value was an ending value
285 /** Create a tokenstream and fill it with the provided data
287 tokenstream(const std::string &source);
290 /** Fetch the next token from the stream as a std::string
291 * @param token The next token available, or an empty string if none remain
292 * @return True if tokens are left to be read, false if the last token was just retrieved.
294 bool GetToken(std::string &token);
296 /** Fetch the next token from the stream as an irc::string
297 * @param token The next token available, or an empty string if none remain
298 * @return True if tokens are left to be read, false if the last token was just retrieved.
300 bool GetToken(irc::string &token);
302 /** Fetch the next token from the stream as an integer
303 * @param token The next token available, or undefined if none remain
304 * @return True if tokens are left to be read, false if the last token was just retrieved.
306 bool GetToken(int &token);
308 /** Fetch the next token from the stream as a long integer
309 * @param token The next token available, or undefined if none remain
310 * @return True if tokens are left to be read, false if the last token was just retrieved.
312 bool GetToken(long &token);
315 /** irc::sepstream allows for splitting token seperated lists.
316 * Each successive call to sepstream::GetToken() returns
317 * the next token, until none remain, at which point the method returns
320 class CoreExport sepstream : public classbase
326 /** Last position of a seperator token
328 std::string::iterator last_starting_position;
329 /** Current string position
331 std::string::iterator n;
336 /** Create a sepstream and fill it with the provided data
338 sepstream(const std::string &source, char seperator);
339 virtual ~sepstream();
341 /** Fetch the next token from the stream
342 * @param token The next token from the stream is placed here
343 * @return True if tokens still remain, false if there are none left
345 virtual bool GetToken(std::string &token);
347 /** Fetch the entire remaining stream, without tokenizing
348 * @return The remaining part of the stream
350 virtual const std::string GetRemaining();
352 /** Returns true if the end of the stream has been reached
353 * @return True if the end of the stream has been reached, otherwise false
355 virtual bool StreamEnd();
358 /** A derived form of sepstream, which seperates on commas
360 class CoreExport commasepstream : public sepstream
363 /** Initialize with comma seperator
365 commasepstream(const std::string &source) : sepstream(source, ',')
370 /** A derived form of sepstream, which seperates on spaces
372 class CoreExport spacesepstream : public sepstream
375 /** Initialize with space seperator
377 spacesepstream(const std::string &source) : sepstream(source, ' ')
382 /** The portparser class seperates out a port range into integers.
383 * A port range may be specified in the input string in the form
384 * "6660,6661,6662-6669,7020". The end of the stream is indicated by
385 * a return value of 0 from portparser::GetToken(). If you attempt
386 * to specify an illegal range (e.g. one where start >= end, or
387 * start or end < 0) then GetToken() will return the first element
388 * of the pair of numbers.
390 class CoreExport portparser : public classbase
393 /** Used to split on commas
396 /** Current position in a range of ports
399 /** Starting port in a range of ports
402 /** Ending port in a range of ports
405 /** Allow overlapped port ranges
408 /** Used to determine overlapping of ports
409 * without O(n) algorithm being used
411 std::map<long, bool> overlap_set;
412 /** Returns true if val overlaps an existing range
414 bool Overlaps(long val);
416 /** Create a portparser and fill it with the provided data
417 * @param source The source text to parse from
418 * @param allow_overlapped Allow overlapped ranges
420 portparser(const std::string &source, bool allow_overlapped = true);
421 /** Frees the internal commasepstream object
424 /** Fetch the next token from the stream
425 * @return The next port number is returned, or 0 if none remain
430 /** Used to hold a bitfield definition in dynamicbitmask.
431 * You must be allocated one of these by dynamicbitmask::Allocate(),
432 * you should not fill the values yourself!
434 typedef std::pair<size_t, unsigned char> bitfield;
436 /** The irc::dynamicbitmask class is used to maintain a bitmap of
437 * boolean values, which can grow to any reasonable size no matter
438 * how many bitfields are in it.
440 * It starts off at 32 bits in size, large enough to hold 32 boolean
441 * values, with a memory allocation of 8 bytes. If you allocate more
442 * than 32 bits, the class will grow the bitmap by 8 bytes at a time
443 * for each set of 8 bitfields you allocate with the Allocate()
446 * This method is designed so that multiple modules can be allocated
447 * bit values in a bitmap dynamically, rather than having to define
448 * costs in a fixed size unsigned integer and having the possibility
449 * of collisions of values in different third party modules.
453 * To use this class, you must derive from it.
454 * This is because each derived instance has its own freebits array
455 * which can determine what bitfields are allocated on a TYPE BY TYPE
456 * basis, e.g. an irc::dynamicbitmask type for Users, and one for
457 * Channels, etc. You should inheret it in a very simple way as follows.
458 * The base class will resize and maintain freebits as required, you are
459 * just required to make the pointer static and specific to this class
463 * class mydbitmask : public irc::dynamicbitmask
467 * static unsigned char* freebits;
471 * mydbitmask() : irc::dynamicbitmask()
473 * freebits = new unsigned char[this->bits_size];
474 * memset(freebits, 0, this->bits_size);
482 * unsigned char* GetFreeBits()
487 * void SetFreeBits(unsigned char* freebt)
494 class CoreExport dynamicbitmask : public classbase
497 /** Data bits. We start with four of these,
498 * and we grow the bitfield as we allocate
499 * more than 32 entries with Allocate().
503 /** Current set size (size of freebits and bits).
504 * Both freebits and bits will ALWAYS be the
507 unsigned char bits_size;
509 /** Allocate the initial memory for bits and
510 * freebits and zero the memory.
514 /** Free the memory used by bits and freebits
516 virtual ~dynamicbitmask();
518 /** Allocate an irc::bitfield.
519 * @return An irc::bitfield which can be used
520 * with Get, Deallocate and Toggle methods.
521 * @throw Can throw std::bad_alloc if there is
522 * no ram left to grow the bitmask.
526 /** Deallocate an irc::bitfield.
527 * @param An irc::bitfield to deallocate.
528 * @return True if the bitfield could be
529 * deallocated, false if it could not.
531 bool Deallocate(bitfield &pos);
533 /** Toggle the value of a bitfield.
534 * @param pos A bitfield to allocate, previously
535 * allocated by dyamicbitmask::Allocate().
536 * @param state The state to set the field to.
538 void Toggle(bitfield &pos, bool state);
540 /** Get the value of a bitfield.
541 * @param pos A bitfield to retrieve, previously
542 * allocated by dyamicbitmask::Allocate().
543 * @return The value of the bitfield.
544 * @throw Will throw ModuleException if the bitfield
545 * you provide is outside of the range
546 * 0 >= bitfield.first < size_bits.
548 bool Get(bitfield &pos);
550 /** Return the size in bytes allocated to the bits
552 * Note that the actual allocation is twice this,
553 * as there are an equal number of bytes allocated
554 * for the freebits array.
556 unsigned char GetSize();
558 /** Get free bits mask
560 virtual unsigned char* GetFreeBits() { return NULL; }
562 /** Set free bits mask
564 virtual void SetFreeBits(unsigned char* freebits) { freebits = freebits; }
567 /** Turn _ characters in a string into spaces
568 * @param n String to translate
569 * @return The new value with _ translated to space.
571 CoreExport const char* Spacify(const char* n);
574 /* Define operators for using >> and << with irc::string to an ostream on an istream. */
575 /* This was endless fun. No. Really. */
576 /* It was also the first core change Ommeh made, if anyone cares */
578 /** Operator << for irc::string
580 inline std::ostream& operator<<(std::ostream &os, const irc::string &str) { return os << str.c_str(); }
582 /** Operator >> for irc::string
584 inline std::istream& operator>>(std::istream &is, irc::string &str)
592 /* Define operators for + and == with irc::string to std::string for easy assignment
597 inline std::string operator+ (std::string& leftval, irc::string& rightval)
599 return leftval + std::string(rightval.c_str());
602 /* Define operators for + and == with irc::string to std::string for easy assignment
607 inline irc::string operator+ (irc::string& leftval, std::string& rightval)
609 return leftval + irc::string(rightval.c_str());
612 /* Define operators for + and == with irc::string to std::string for easy assignment
617 inline bool operator== (const std::string& leftval, const irc::string& rightval)
619 return (leftval.c_str() == rightval);
622 /* Define operators for + and == with irc::string to std::string for easy assignment
627 inline bool operator== (const irc::string& leftval, const std::string& rightval)
629 return (leftval == rightval.c_str());
632 /* Define operators != for irc::string to std::string for easy comparison
634 inline bool operator!= (const irc::string& leftval, const std::string& rightval)
636 return !(leftval == rightval.c_str());
639 /* Define operators != for std::string to irc::string for easy comparison
641 inline bool operator!= (const std::string& leftval, const irc::string& rightval)
643 return !(leftval.c_str() == rightval);
646 // FIXME MAXBUF messes up these
648 template<std::size_t N>
649 static inline bool operator == (std::string const &lhs, char const (&rhs)[N])
651 return lhs.length() == N - 1 && !std::memcmp(lhs.data(), rhs, N - 1);
654 template<std::size_t N>
655 static inline bool operator != (std::string const &lhs, char const (&rhs)[N])
657 return !(lhs == rhs);
661 /** Assign an irc::string to a std::string.
663 inline std::string assign(const irc::string &other) { return other.c_str(); }
665 /** Assign a std::string to an irc::string.
667 inline irc::string assign(const std::string &other) { return other.c_str(); }
669 /** Trim the leading and trailing spaces from a std::string.
671 inline std::string& trim(std::string &str)
673 std::string::size_type start = str.find_first_not_of(" ");
674 std::string::size_type end = str.find_last_not_of(" ");
675 if (start == std::string::npos || end == std::string::npos)
678 str = str.substr(start, end-start+1);
683 /** Hashing stuff is totally different on vc++'s hash_map implementation, so to save a buttload of
684 * #ifdefs we'll just do it all at once
686 BEGIN_HASHMAP_NAMESPACE
688 /** Hashing function to hash irc::string
691 template<> class CoreExport hash_compare<irc::string, std::less<irc::string> >
694 enum { bucket_size = 4, min_buckets = 8 }; /* Got these numbers from the CRT source, if anyone wants to change them feel free. */
696 /** Compare two irc::string values for hashing in hash_map
698 bool operator()(const irc::string & s1, const irc::string & s2) const
700 if(s1.length() != s2.length()) return true;
701 return (irc::irc_char_traits::compare(s1.c_str(), s2.c_str(), s1.length()) < 0);
704 /** Hash an irc::string value for hash_map
706 size_t operator()(const irc::string & s) const;
709 template<> class CoreExport hash_compare<std::string, std::less<std::string> >
712 enum { bucket_size = 4, min_buckets = 8 }; /* Again, from the CRT source */
714 /** Compare two std::string values for hashing in hash_map
716 bool operator()(const std::string & s1, const std::string & s2) const
718 if(s1.length() != s2.length()) return true;
719 return (irc::irc_char_traits::compare(s1.c_str(), s2.c_str(), s1.length()) < 0);
722 /** Hash a std::string using RFC1459 case sensitivity rules
723 * @param s A string to hash
724 * @return The hash value
726 size_t operator()(const std::string & s) const;
730 template<> struct hash<irc::string>
732 /** Hash an irc::string using RFC1459 case sensitivity rules
733 * @param s A string to hash
734 * @return The hash value
736 size_t operator()(const irc::string &s) const;
739 /* XXX FIXME: Implement a hash function overriding std::string's that works with TR1! */
741 #ifdef HASHMAP_DEPRECATED
744 template<> struct hash<std::string>
747 size_t operator()(const std::string &s) const;
752 /** Convert a string to lower case respecting RFC1459
753 * @param n A string to lowercase
755 void strlower(char *n);
757 END_HASHMAP_NAMESPACE