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 *******************************************************/
36 /** Required namespaces and symbols */
40 using irc::sockets::insp_aton;
43 using irc::sockets::insp_ntoa;
47 /** A mapping of uppercase to lowercase, including scandinavian
48 * 'oddities' as specified by RFC1459, e.g. { -> [, and | -> \
50 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 */
51 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, /* 20-39 */
52 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, /* 40-59 */
53 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, /* 60-79 */
54 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 94, 95, 96, 97, 98, 99, /* 80-99 */
55 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, /* 100-119 */
56 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, /* 120-139 */
57 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, /* 140-159 */
58 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, /* 160-179 */
59 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, /* 180-199 */
60 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, /* 200-219 */
61 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, /* 220-239 */
62 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254, 255 /* 240-255 */
66 /** The irc namespace contains a number of helper classes.
71 /** This class returns true if two strings match.
72 * Case sensitivity is ignored, and the RFC 'character set'
77 /** The operator () does the actual comparison in hash_map
79 bool operator()(const std::string& s1, const std::string& s2) const;
82 /** The irc_char_traits class is used for RFC-style comparison of strings.
83 * This class is used to implement irc::string, a case-insensitive, RFC-
84 * comparing string class.
86 struct irc_char_traits : std::char_traits<char> {
88 /** Check if two chars match.
89 * @param c1st First character
90 * @param c2nd Second character
91 * @return true if the characters are equal
93 static bool eq(char c1st, char c2nd);
95 /** Check if two chars do NOT match.
96 * @param c1st First character
97 * @param c2nd Second character
98 * @return true if the characters are unequal
100 static bool ne(char c1st, char c2nd);
102 /** Check if one char is less than another.
103 * @param c1st First character
104 * @param c2nd Second character
105 * @return true if c1st is less than c2nd
107 static bool lt(char c1st, char c2nd);
109 /** Compare two strings of size n.
110 * @param str1 First string
111 * @param str2 Second string
112 * @param n Length to compare to
113 * @return similar to strcmp, zero for equal, less than zero for str1
114 * being less and greater than zero for str1 being greater than str2.
116 static CoreExport int compare(const char* str1, const char* str2, size_t n);
118 /** Find a char within a string up to position n.
119 * @param s1 String to find in
120 * @param n Position to search up to
121 * @param c Character to search for
122 * @return Pointer to the first occurance of c in s1
124 static CoreExport const char* find(const char* s1, int n, char c);
127 /** Compose a hex string from raw data.
128 * @param raw The raw data to compose hex from
129 * @pram rawsz The size of the raw data buffer
130 * @return The hex string.
132 CoreExport std::string hex(const unsigned char *raw, size_t rawsz);
134 /** This typedef declares irc::string based upon irc_char_traits.
136 typedef basic_string<char, irc_char_traits, allocator<char> > string;
138 /** irc::stringjoiner joins string lists into a string, using
139 * the given seperator string.
140 * This class can join a vector of std::string, a deque of
141 * std::string, or a const char** array, using overloaded
144 class CoreExport stringjoiner
151 /** Join elements of a vector, between (and including) begin and end
152 * @param seperator The string to seperate values with
153 * @param sequence One or more items to seperate
154 * @param begin The starting element in the sequence to be joined
155 * @param end The ending element in the sequence to be joined
157 stringjoiner(const std::string &seperator, const std::vector<std::string> &sequence, int begin, int end);
158 /** Join elements of a deque, between (and including) begin and end
159 * @param seperator The string to seperate values with
160 * @param sequence One or more items to seperate
161 * @param begin The starting element in the sequence to be joined
162 * @param end The ending element in the sequence to be joined
164 stringjoiner(const std::string &seperator, const std::deque<std::string> &sequence, int begin, int end);
165 /** Join elements of an array of char arrays, 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 char** sequence, int begin, int end);
173 /** Get the joined sequence
174 * @return A reference to the joined string
176 std::string& GetJoined();
179 /** irc::modestacker stacks mode sequences into a list.
180 * It can then reproduce this list, clamped to a maximum of MAXMODES
183 class CoreExport modestacker
186 /** The mode sequence and its parameters
188 std::deque<std::string> sequence;
189 /** True if the mode sequence is initially adding
190 * characters, false if it is initially removing
195 /** Construct a new modestacker.
196 * @param add True if the stack is adding modes,
197 * false if it is removing them
199 modestacker(bool add);
200 /** Push a modeletter and its 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
206 * @param parameter The parameter for the mode
208 void Push(char modeletter, const std::string ¶meter);
209 /** Push a modeletter without parameter onto the stack.
210 * No checking is performed as to if this mode actually
211 * requires a parameter. If you stack invalid mode
212 * sequences, they will be tidied if and when they are
213 * passed to a mode parser.
214 * @param modeletter The mode letter to insert
216 void Push(char modeletter);
217 /** Push a '+' symbol onto the stack.
220 /** Push a '-' symbol onto the stack.
223 /** Return zero or more elements which form the
224 * mode line. This will be clamped to a max of
225 * MAXMODES items (MAXMODES-1 mode parameters and
226 * one mode sequence string), and max_line_size
227 * characters. As specified below, this function
228 * should be called in a loop until it returns zero,
229 * indicating there are no more modes to return.
230 * @param result The deque to populate. This will
231 * be cleared before it is used.
232 * @param max_line_size The maximum size of the line
233 * to build, in characters, seperate to MAXMODES.
234 * @return The number of elements in the deque.
235 * The function should be called repeatedly until it
236 * returns 0, in case there are multiple lines of
237 * mode changes to be obtained.
239 int GetStackedLine(std::deque<std::string> &result, int max_line_size = 360);
242 /** irc::tokenstream reads a string formatted as per RFC1459 and RFC2812.
243 * It will split the string into 'tokens' each containing one parameter
245 * For instance, if it is instantiated with the string:
246 * "PRIVMSG #test :foo bar baz qux"
247 * then each successive call to tokenstream::GetToken() will return
248 * "PRIVMSG", "#test", "foo bar baz qux", "".
249 * Note that if the whole string starts with a colon this is not taken
250 * to mean the string is all one parameter, and the first item in the
251 * list will be ":item". This is to allow for parsing 'source' fields
254 class CoreExport tokenstream
260 /** Last position of a seperator token
262 std::string::iterator last_starting_position;
263 /** Current string position
265 std::string::iterator n;
266 /** True if the last value was an ending value
270 /** Create a tokenstream and fill it with the provided data
272 tokenstream(const std::string &source);
275 /** Fetch the next token from the stream as a std::string
276 * @param token The next token available, or an empty string if none remain
277 * @return True if tokens are left to be read, false if the last token was just retrieved.
279 bool GetToken(std::string &token);
281 /** Fetch the next token from the stream as an irc::string
282 * @param token The next token available, or an empty string if none remain
283 * @return True if tokens are left to be read, false if the last token was just retrieved.
285 bool GetToken(irc::string &token);
287 /** Fetch the next token from the stream as an integer
288 * @param token The next token available, or undefined if none remain
289 * @return True if tokens are left to be read, false if the last token was just retrieved.
291 bool GetToken(int &token);
293 /** Fetch the next token from the stream as a long integer
294 * @param token The next token available, or undefined if none remain
295 * @return True if tokens are left to be read, false if the last token was just retrieved.
297 bool GetToken(long &token);
300 /** irc::sepstream allows for splitting token seperated lists.
301 * Each successive call to sepstream::GetToken() returns
302 * the next token, until none remain, at which point the method returns
305 class CoreExport sepstream : public classbase
311 /** Last position of a seperator token
313 std::string::iterator last_starting_position;
314 /** Current string position
316 std::string::iterator n;
321 /** Create a sepstream and fill it with the provided data
323 sepstream(const std::string &source, char seperator);
324 virtual ~sepstream();
326 /** Fetch the next token from the stream
327 * @return The next token is returned, or an empty string if none remain
329 virtual const std::string GetToken();
331 /** Fetch the entire remaining stream, without tokenizing
332 * @return The remaining part of the stream
334 virtual const std::string GetRemaining();
336 /** Returns true if the end of the stream has been reached
337 * @return True if the end of the stream has been reached, otherwise false
339 virtual bool StreamEnd();
342 /** A derived form of sepstream, which seperates on commas
344 class CoreExport commasepstream : public sepstream
347 /** Initialize with comma seperator
349 commasepstream(const std::string &source) : sepstream(source, ',')
354 /** A derived form of sepstream, which seperates on spaces
356 class CoreExport spacesepstream : public sepstream
359 /** Initialize with space seperator
361 spacesepstream(const std::string &source) : sepstream(source, ' ')
366 /** The portparser class seperates out a port range into integers.
367 * A port range may be specified in the input string in the form
368 * "6660,6661,6662-6669,7020". The end of the stream is indicated by
369 * a return value of 0 from portparser::GetToken(). If you attempt
370 * to specify an illegal range (e.g. one where start >= end, or
371 * start or end < 0) then GetToken() will return the first element
372 * of the pair of numbers.
374 class CoreExport portparser : public classbase
377 /** Used to split on commas
380 /** Current position in a range of ports
383 /** Starting port in a range of ports
386 /** Ending port in a range of ports
389 /** Allow overlapped port ranges
392 /** Used to determine overlapping of ports
393 * without O(n) algorithm being used
395 std::map<long, bool> overlap_set;
396 /** Returns true if val overlaps an existing range
398 bool Overlaps(long val);
400 /** Create a portparser and fill it with the provided data
401 * @param source The source text to parse from
402 * @param allow_overlapped Allow overlapped ranges
404 portparser(const std::string &source, bool allow_overlapped = true);
405 /** Frees the internal commasepstream object
408 /** Fetch the next token from the stream
409 * @return The next port number is returned, or 0 if none remain
414 /** Used to hold a bitfield definition in dynamicbitmask.
415 * You must be allocated one of these by dynamicbitmask::Allocate(),
416 * you should not fill the values yourself!
418 typedef std::pair<size_t, unsigned char> bitfield;
420 /** The irc::dynamicbitmask class is used to maintain a bitmap of
421 * boolean values, which can grow to any reasonable size no matter
422 * how many bitfields are in it.
424 * It starts off at 32 bits in size, large enough to hold 32 boolean
425 * values, with a memory allocation of 8 bytes. If you allocate more
426 * than 32 bits, the class will grow the bitmap by 8 bytes at a time
427 * for each set of 8 bitfields you allocate with the Allocate()
430 * This method is designed so that multiple modules can be allocated
431 * bit values in a bitmap dynamically, rather than having to define
432 * costs in a fixed size unsigned integer and having the possibility
433 * of collisions of values in different third party modules.
437 * To use this class, you must derive from it.
438 * This is because each derived instance has its own freebits array
439 * which can determine what bitfields are allocated on a TYPE BY TYPE
440 * basis, e.g. an irc::dynamicbitmask type for userrecs, and one for
441 * chanrecs, etc. You should inheret it in a very simple way as follows.
442 * The base class will resize and maintain freebits as required, you are
443 * just required to make the pointer static and specific to this class
447 * class mydbitmask : public irc::dynamicbitmask
451 * static unsigned char* freebits;
455 * mydbitmask() : irc::dynamicbitmask()
457 * freebits = new unsigned char[this->bits_size];
458 * memset(freebits, 0, this->bits_size);
466 * unsigned char* GetFreeBits()
471 * void SetFreeBits(unsigned char* freebt)
478 class CoreExport dynamicbitmask : public classbase
481 /** Data bits. We start with four of these,
482 * and we grow the bitfield as we allocate
483 * more than 32 entries with Allocate().
487 /** Current set size (size of freebits and bits).
488 * Both freebits and bits will ALWAYS be the
491 unsigned char bits_size;
493 /** Allocate the initial memory for bits and
494 * freebits and zero the memory.
498 /** Free the memory used by bits and freebits
500 virtual ~dynamicbitmask();
502 /** Allocate an irc::bitfield.
503 * @return An irc::bitfield which can be used
504 * with Get, Deallocate and Toggle methods.
505 * @throw Can throw std::bad_alloc if there is
506 * no ram left to grow the bitmask.
510 /** Deallocate an irc::bitfield.
511 * @param An irc::bitfield to deallocate.
512 * @return True if the bitfield could be
513 * deallocated, false if it could not.
515 bool Deallocate(bitfield &pos);
517 /** Toggle the value of a bitfield.
518 * @param pos A bitfield to allocate, previously
519 * allocated by dyamicbitmask::Allocate().
520 * @param state The state to set the field to.
522 void Toggle(bitfield &pos, bool state);
524 /** Get the value of a bitfield.
525 * @param pos A bitfield to retrieve, previously
526 * allocated by dyamicbitmask::Allocate().
527 * @return The value of the bitfield.
528 * @throw Will throw ModuleException if the bitfield
529 * you provide is outside of the range
530 * 0 >= bitfield.first < size_bits.
532 bool Get(bitfield &pos);
534 /** Return the size in bytes allocated to the bits
536 * Note that the actual allocation is twice this,
537 * as there are an equal number of bytes allocated
538 * for the freebits array.
540 unsigned char GetSize();
542 /** Get free bits mask
544 virtual unsigned char* GetFreeBits() { return NULL; }
546 /** Set free bits mask
548 virtual void SetFreeBits(unsigned char* freebits) { }
551 /** Turn _ characters in a string into spaces
552 * @param n String to translate
553 * @return The new value with _ translated to space.
555 CoreExport const char* Spacify(const char* n);
558 /* Define operators for using >> and << with irc::string to an ostream on an istream. */
559 /* This was endless fun. No. Really. */
560 /* It was also the first core change Ommeh made, if anyone cares */
562 /** Operator << for irc::string
564 inline std::ostream& operator<<(std::ostream &os, const irc::string &str) { return os << str.c_str(); }
566 /** Operator >> for irc::string
568 inline std::istream& operator>>(std::istream &is, irc::string &str)
576 /* Define operators for + and == with irc::string to std::string for easy assignment
581 inline std::string operator+ (std::string& leftval, irc::string& rightval)
583 return leftval + std::string(rightval.c_str());
586 /* Define operators for + and == with irc::string to std::string for easy assignment
591 inline irc::string operator+ (irc::string& leftval, std::string& rightval)
593 return leftval + irc::string(rightval.c_str());
596 /* Define operators for + and == with irc::string to std::string for easy assignment
601 inline bool operator== (const std::string& leftval, const irc::string& rightval)
603 return (leftval.c_str() == rightval);
606 /* Define operators for + and == with irc::string to std::string for easy assignment
611 inline bool operator== (const irc::string& leftval, const std::string& rightval)
613 return (leftval == rightval.c_str());
616 /* Define operators != for irc::string to std::string for easy comparison
618 inline bool operator!= (const irc::string& leftval, const std::string& rightval)
620 return !(leftval == rightval.c_str());
623 /* Define operators != for std::string to irc::string for easy comparison
625 inline bool operator!= (const std::string& leftval, const irc::string& rightval)
627 return !(leftval.c_str() == rightval);
630 /** Assign an irc::string to a std::string.
632 inline std::string assign(const irc::string &other) { return other.c_str(); }
634 /** Assign a std::string to an irc::string.
636 inline irc::string assign(const std::string &other) { return other.c_str(); }
638 /** Trim the leading and trailing spaces from a std::string.
640 inline std::string& trim(std::string &str)
642 std::string::size_type start = str.find_first_not_of(" ");
643 std::string::size_type end = str.find_last_not_of(" ");
644 if (start == std::string::npos || end == std::string::npos)
647 str = str.substr(start, end-start+1);
652 /** Hashing stuff is totally different on vc++'s hash_map implementation, so to save a buttload of
653 * #ifdefs we'll just do it all at once
657 /** Hashing function to hash irc::string
660 template<> class CoreExport hash_compare<irc::string, std::less<irc::string> >
663 enum { bucket_size = 4, min_buckets = 8 }; /* Got these numbers from the CRT source, if anyone wants to change them feel free. */
665 /** Compare two irc::string values for hashing in hash_map
667 bool operator()(const irc::string & s1, const irc::string & s2) const
669 if(s1.length() != s2.length()) return true;
670 return (irc::irc_char_traits::compare(s1.c_str(), s2.c_str(), s1.length()) < 0);
673 /** Hash an irc::string value for hash_map
675 size_t operator()(const irc::string & s) const;
678 template<> class CoreExport hash_compare<std::string, std::less<std::string> >
681 enum { bucket_size = 4, min_buckets = 8 }; /* Again, from the CRT source */
683 /** Compare two std::string values for hashing in hash_map
685 bool operator()(const std::string & s1, const std::string & s2) const
687 if(s1.length() != s2.length()) return true;
688 return (irc::irc_char_traits::compare(s1.c_str(), s2.c_str(), s1.length()) < 0);
691 /** Hash a std::string using RFC1459 case sensitivity rules
692 * @param s A string to hash
693 * @return The hash value
695 size_t operator()(const std::string & s) const;
698 template<> struct hash<irc::string>
700 /** Hash an irc::string using RFC1459 case sensitivity rules
701 * @param s A string to hash
702 * @return The hash value
704 size_t operator()(const irc::string &s) const;
707 template<> struct hash<std::string>
709 /** Hash a std::string using RFC1459 case sensitivity rules
710 * @param s A string to hash
711 * @return The hash value
713 size_t operator()(const string &s) const;
717 /** Convert a string to lower case respecting RFC1459
718 * @param n A string to lowercase
720 void strlower(char *n);