1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2007 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 *******************************************************/
37 using irc::sockets::insp_aton;
38 using irc::sockets::insp_ntoa;
42 /** A mapping of uppercase to lowercase, including scandinavian
43 * 'oddities' as specified by RFC1459, e.g. { -> [, and | -> \
45 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 */
46 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, /* 20-39 */
47 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, /* 40-59 */
48 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, /* 60-79 */
49 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 94, 95, 96, 97, 98, 99, /* 80-99 */
50 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, /* 100-119 */
51 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, /* 120-139 */
52 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, /* 140-159 */
53 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, /* 160-179 */
54 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, /* 180-199 */
55 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, /* 200-219 */
56 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, /* 220-239 */
57 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254, 255 /* 240-255 */
61 /** The irc namespace contains a number of helper classes.
66 /** This class returns true if two strings match.
67 * Case sensitivity is ignored, and the RFC 'character set'
72 /** The operator () does the actual comparison in hash_map
74 bool operator()(const std::string& s1, const std::string& s2) const;
78 /** irc::stringjoiner joins string lists into a string, using
79 * the given seperator string.
80 * This class can join a vector of std::string, a deque of
81 * std::string, or a const char** array, using overloaded
84 class CoreExport stringjoiner
91 /** Join elements of a vector, between (and including) begin and end
92 * @param seperator The string to seperate values with
93 * @param sequence One or more items to seperate
94 * @param begin The starting element in the sequence to be joined
95 * @param end The ending element in the sequence to be joined
97 stringjoiner(const std::string &seperator, const std::vector<std::string> &sequence, int begin, int end);
98 /** Join elements of a deque, between (and including) begin and end
99 * @param seperator The string to seperate values with
100 * @param sequence One or more items to seperate
101 * @param begin The starting element in the sequence to be joined
102 * @param end The ending element in the sequence to be joined
104 stringjoiner(const std::string &seperator, const std::deque<std::string> &sequence, int begin, int end);
105 /** Join elements of an array of char arrays, between (and including) begin and end
106 * @param seperator The string to seperate values with
107 * @param sequence One or more items to seperate
108 * @param begin The starting element in the sequence to be joined
109 * @param end The ending element in the sequence to be joined
111 stringjoiner(const std::string &seperator, const char** sequence, int begin, int end);
113 /** Get the joined sequence
114 * @return A reference to the joined string
116 std::string& GetJoined();
119 /** irc::modestacker stacks mode sequences into a list.
120 * It can then reproduce this list, clamped to a maximum of MAXMODES
123 class CoreExport modestacker
126 /** The mode sequence and its parameters
128 std::deque<std::string> sequence;
129 /** True if the mode sequence is initially adding
130 * characters, false if it is initially removing
135 /** Construct a new modestacker.
136 * @param add True if the stack is adding modes,
137 * false if it is removing them
139 modestacker(bool add);
140 /** Push a modeletter and its parameter onto the stack.
141 * No checking is performed as to if this mode actually
142 * requires a parameter. If you stack invalid mode
143 * sequences, they will be tidied if and when they are
144 * passed to a mode parser.
145 * @param modeletter The mode letter to insert
146 * @param parameter The parameter for the mode
148 void Push(char modeletter, const std::string ¶meter);
149 /** Push a modeletter without parameter onto the stack.
150 * No checking is performed as to if this mode actually
151 * requires a parameter. If you stack invalid mode
152 * sequences, they will be tidied if and when they are
153 * passed to a mode parser.
154 * @param modeletter The mode letter to insert
156 void Push(char modeletter);
157 /** Push a '+' symbol onto the stack.
160 /** Push a '-' symbol onto the stack.
163 /** Return zero or more elements which form the
164 * mode line. This will be clamped to a max of
165 * MAXMODES+1 items (MAXMODES mode parameters and
166 * one mode sequence string), and max_line_size
167 * characters. As specified below, this function
168 * should be called in a loop until it returns zero,
169 * indicating there are no more modes to return.
170 * @param result The deque to populate. This will
171 * be cleared before it is used.
172 * @param max_line_size The maximum size of the line
173 * to build, in characters, seperate to MAXMODES.
174 * @return The number of elements in the deque.
175 * The function should be called repeatedly until it
176 * returns 0, in case there are multiple lines of
177 * mode changes to be obtained.
179 int GetStackedLine(std::deque<std::string> &result, int max_line_size = 360);
182 /** irc::tokenstream reads a string formatted as per RFC1459 and RFC2812.
183 * It will split the string into 'tokens' each containing one parameter
185 * For instance, if it is instantiated with the string:
186 * "PRIVMSG #test :foo bar baz qux"
187 * then each successive call to tokenstream::GetToken() will return
188 * "PRIVMSG", "#test", "foo bar baz qux", "".
189 * Note that if the whole string starts with a colon this is not taken
190 * to mean the string is all one parameter, and the first item in the
191 * list will be ":item". This is to allow for parsing 'source' fields
194 class CoreExport tokenstream
200 /** Last position of a seperator token
202 std::string::iterator last_starting_position;
203 /** Current string position
205 std::string::iterator n;
206 /** True if the last value was an ending value
210 /** Create a tokenstream and fill it with the provided data
212 tokenstream(const std::string &source);
215 /** Fetch the next token from the stream
216 * @return The next token is returned, or an empty string if none remain
218 bool GetToken(std::string &token);
221 /** irc::sepstream allows for splitting token seperated lists.
222 * Each successive call to sepstream::GetToken() returns
223 * the next token, until none remain, at which point the method returns
226 class CoreExport sepstream : public classbase
232 /** Last position of a seperator token
234 std::string::iterator last_starting_position;
235 /** Current string position
237 std::string::iterator n;
242 /** Create a sepstream and fill it with the provided data
244 sepstream(const std::string &source, char seperator);
245 virtual ~sepstream();
247 /** Fetch the next token from the stream
248 * @return The next token is returned, or an empty string if none remain
250 virtual const std::string GetToken();
252 /** Fetch the entire remaining stream, without tokenizing
253 * @return The remaining part of the stream
255 virtual const std::string GetRemaining();
257 /** Returns true if the end of the stream has been reached
258 * @return True if the end of the stream has been reached, otherwise false
260 virtual bool StreamEnd();
263 /** A derived form of sepstream, which seperates on commas
265 class CoreExport commasepstream : public sepstream
268 commasepstream(const std::string &source) : sepstream(source, ',')
273 /** A derived form of sepstream, which seperates on spaces
275 class CoreExport spacesepstream : public sepstream
278 spacesepstream(const std::string &source) : sepstream(source, ' ')
283 /** The portparser class seperates out a port range into integers.
284 * A port range may be specified in the input string in the form
285 * "6660,6661,6662-6669,7020". The end of the stream is indicated by
286 * a return value of 0 from portparser::GetToken(). If you attempt
287 * to specify an illegal range (e.g. one where start >= end, or
288 * start or end < 0) then GetToken() will return the first element
289 * of the pair of numbers.
291 class CoreExport portparser : public classbase
294 /** Used to split on commas
297 /** Current position in a range of ports
300 /** Starting port in a range of ports
303 /** Ending port in a range of ports
306 /** Allow overlapped port ranges
309 /** Used to determine overlapping of ports
310 * without O(n) algorithm being used
312 std::map<long, bool> overlap_set;
313 /** Returns true if val overlaps an existing range
315 bool Overlaps(long val);
317 /** Create a portparser and fill it with the provided data
318 * @param source The source text to parse from
319 * @param allow_overlapped Allow overlapped ranges
321 portparser(const std::string &source, bool allow_overlapped = true);
322 /** Frees the internal commasepstream object
325 /** Fetch the next token from the stream
326 * @return The next port number is returned, or 0 if none remain
331 /** Used to hold a bitfield definition in dynamicbitmask.
332 * You must be allocated one of these by dynamicbitmask::Allocate(),
333 * you should not fill the values yourself!
335 typedef std::pair<size_t, unsigned char> bitfield;
337 /** The irc::dynamicbitmask class is used to maintain a bitmap of
338 * boolean values, which can grow to any reasonable size no matter
339 * how many bitfields are in it.
341 * It starts off at 32 bits in size, large enough to hold 32 boolean
342 * values, with a memory allocation of 8 bytes. If you allocate more
343 * than 32 bits, the class will grow the bitmap by 8 bytes at a time
344 * for each set of 8 bitfields you allocate with the Allocate()
347 * This method is designed so that multiple modules can be allocated
348 * bit values in a bitmap dynamically, rather than having to define
349 * costs in a fixed size unsigned integer and having the possibility
350 * of collisions of values in different third party modules.
354 * To use this class, you must derive from it.
355 * This is because each derived instance has its own freebits array
356 * which can determine what bitfields are allocated on a TYPE BY TYPE
357 * basis, e.g. an irc::dynamicbitmask type for userrecs, and one for
358 * chanrecs, etc. You should inheret it in a very simple way as follows.
359 * The base class will resize and maintain freebits as required, you are
360 * just required to make the pointer static and specific to this class
364 * class mydbitmask : public irc::dynamicbitmask
368 * static unsigned char* freebits;
372 * mydbitmask() : irc::dynamicbitmask()
374 * freebits = new unsigned char[this->bits_size];
375 * memset(freebits, 0, this->bits_size);
383 * unsigned char* GetFreeBits()
388 * void SetFreeBits(unsigned char* freebt)
395 class CoreExport dynamicbitmask : public classbase
398 /** Data bits. We start with four of these,
399 * and we grow the bitfield as we allocate
400 * more than 32 entries with Allocate().
404 /** Current set size (size of freebits and bits).
405 * Both freebits and bits will ALWAYS be the
408 unsigned char bits_size;
410 /** Allocate the initial memory for bits and
411 * freebits and zero the memory.
415 /** Free the memory used by bits and freebits
417 virtual ~dynamicbitmask();
419 /** Allocate an irc::bitfield.
420 * @return An irc::bitfield which can be used
421 * with Get, Deallocate and Toggle methods.
422 * @throw Can throw std::bad_alloc if there is
423 * no ram left to grow the bitmask.
427 /** Deallocate an irc::bitfield.
428 * @param An irc::bitfield to deallocate.
429 * @return True if the bitfield could be
430 * deallocated, false if it could not.
432 bool Deallocate(bitfield &pos);
434 /** Toggle the value of a bitfield.
435 * @param pos A bitfield to allocate, previously
436 * allocated by dyamicbitmask::Allocate().
437 * @param state The state to set the field to.
439 void Toggle(bitfield &pos, bool state);
441 /** Get the value of a bitfield.
442 * @param pos A bitfield to retrieve, previously
443 * allocated by dyamicbitmask::Allocate().
444 * @return The value of the bitfield.
445 * @throw Will throw ModuleException if the bitfield
446 * you provide is outside of the range
447 * 0 >= bitfield.first < size_bits.
449 bool Get(bitfield &pos);
451 /** Return the size in bytes allocated to the bits
453 * Note that the actual allocation is twice this,
454 * as there are an equal number of bytes allocated
455 * for the freebits array.
457 unsigned char GetSize();
459 virtual unsigned char* GetFreeBits() { return NULL; }
461 virtual void SetFreeBits(unsigned char* freebits) { }
464 /** The irc_char_traits class is used for RFC-style comparison of strings.
465 * This class is used to implement irc::string, a case-insensitive, RFC-
466 * comparing string class.
468 struct irc_char_traits : std::char_traits<char> {
470 /** Check if two chars match
472 static bool eq(char c1st, char c2nd);
474 /** Check if two chars do NOT match
476 static bool ne(char c1st, char c2nd);
478 /** Check if one char is less than another
480 static bool lt(char c1st, char c2nd);
482 /** Compare two strings of size n
484 static CoreExport int compare(const char* str1, const char* str2, size_t n);
486 /** Find a char within a string up to position n
488 static CoreExport const char* find(const char* s1, int n, char c);
491 CoreExport std::string hex(const unsigned char *raw, size_t rawsz);
493 /** This typedef declares irc::string based upon irc_char_traits
495 typedef basic_string<char, irc_char_traits, allocator<char> > string;
497 CoreExport const char* Spacify(const char* n);
500 /* Define operators for using >> and << with irc::string to an ostream on an istream. */
501 /* This was endless fun. No. Really. */
502 /* It was also the first core change Ommeh made, if anyone cares */
503 inline std::ostream& operator<<(std::ostream &os, const irc::string &str) { return os << str.c_str(); }
504 inline std::istream& operator>>(std::istream &is, irc::string &str)
512 /* Define operators for + and == with irc::string to std::string for easy assignment
513 * and comparison - Brain
515 inline std::string operator+ (std::string& leftval, irc::string& rightval)
517 return leftval + std::string(rightval.c_str());
520 inline irc::string operator+ (irc::string& leftval, std::string& rightval)
522 return leftval + irc::string(rightval.c_str());
525 inline bool operator== (const std::string& leftval, const irc::string& rightval)
527 return (leftval.c_str() == rightval);
530 inline bool operator== (const irc::string& leftval, const std::string& rightval)
532 return (leftval == rightval.c_str());
535 inline std::string assign(const irc::string &other) { return other.c_str(); }
536 inline irc::string assign(const std::string &other) { return other.c_str(); }
537 inline std::string& trim(std::string &str)
539 std::string::size_type start = str.find_first_not_of(" ");
540 std::string::size_type end = str.find_last_not_of(" ");
541 if (start == std::string::npos || end == std::string::npos)
544 str = str.substr(start, end-start+1);
549 /* Hashing stuff is totally different on vc++'s hash_map implementation, so to save a buttload of #ifdefs we'll just
550 do it all at once - Burlex */
554 /** Hashing function to hash irc::string
557 template<> class CoreExport hash_compare<irc::string, std::less<irc::string> >
560 enum { bucket_size = 4, min_buckets = 8 }; // Got these numbers from the CRT source,
561 // if anyone wants to change them feel free.
562 bool operator()(const irc::string & s1, const irc::string & s2) const
564 if(s1.length() != s2.length()) return true;
565 return (irc::irc_char_traits::compare(s1.c_str(), s2.c_str(), s1.length()) < 0);
568 size_t operator()(const irc::string & s) const;
571 template<> class CoreExport hash_compare<std::string, std::less<std::string> >
574 enum { bucket_size = 4, min_buckets = 8 };
575 bool operator()(const std::string & s1, const std::string & s2) const
577 if(s1.length() != s2.length()) return true;
578 return (irc::irc_char_traits::compare(s1.c_str(), s2.c_str(), s1.length()) < 0);
581 /** Hash a std::string using RFC1459 case sensitivity rules
582 * @param s A string to hash
583 * @return The hash value
585 size_t operator()(const std::string & s) const;
588 template<> struct hash<irc::string>
590 size_t operator()(const irc::string &s) const;
593 template<> struct hash<std::string>
595 /** Hash a std::string using RFC1459 case sensitivity rules
596 * @param s A string to hash
597 * @return The hash value
599 size_t operator()(const string &s) const;
603 /** Convert a string to lower case respecting RFC1459
604 * @param n A string to lowercase
606 void strlower(char *n);