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 /** Because of weirdness in g++, before 3.x this was namespace std. It's now __gnu_cxx.
62 * This is a #define'd alias.
66 /** Convert a string to lower case respecting RFC1459
67 * @param n A string to lowercase
69 void strlower(char *n);
71 /** Hashing function to hash std::string without respect to case
73 template<> struct hash<std::string>
75 /** Hash a std::string using RFC1459 case sensitivity rules
76 * @param s A string to hash
77 * @return The hash value
79 size_t operator()(const string &s) const;
83 /** The irc namespace contains a number of helper classes.
88 /** This class returns true if two strings match.
89 * Case sensitivity is ignored, and the RFC 'character set'
94 /** The operator () does the actual comparison in hash_map
96 bool operator()(const std::string& s1, const std::string& s2) const;
100 /** irc::stringjoiner joins string lists into a string, using
101 * the given seperator string.
102 * This class can join a vector of std::string, a deque of
103 * std::string, or a const char** array, using overloaded
113 /** Join elements of a vector, between (and including) begin and end
114 * @param seperator The string to seperate values with
115 * @param sequence One or more items to seperate
116 * @param begin The starting element in the sequence to be joined
117 * @param end The ending element in the sequence to be joined
119 stringjoiner(const std::string &seperator, const std::vector<std::string> &sequence, int begin, int end);
120 /** Join elements of a deque, between (and including) begin and end
121 * @param seperator The string to seperate values with
122 * @param sequence One or more items to seperate
123 * @param begin The starting element in the sequence to be joined
124 * @param end The ending element in the sequence to be joined
126 stringjoiner(const std::string &seperator, const std::deque<std::string> &sequence, int begin, int end);
127 /** Join elements of an array of char arrays, between (and including) begin and end
128 * @param seperator The string to seperate values with
129 * @param sequence One or more items to seperate
130 * @param begin The starting element in the sequence to be joined
131 * @param end The ending element in the sequence to be joined
133 stringjoiner(const std::string &seperator, const char** sequence, int begin, int end);
135 /** Get the joined sequence
136 * @return A reference to the joined string
138 std::string& GetJoined();
141 /** irc::modestacker stacks mode sequences into a list.
142 * It can then reproduce this list, clamped to a maximum of MAXMODES
148 /** The mode sequence and its parameters
150 std::deque<std::string> sequence;
151 /** True if the mode sequence is initially adding
152 * characters, false if it is initially removing
157 /** Construct a new modestacker.
158 * @param add True if the stack is adding modes,
159 * false if it is removing them
161 modestacker(bool add);
162 /** Push a modeletter and its parameter onto the stack.
163 * No checking is performed as to if this mode actually
164 * requires a parameter. If you stack invalid mode
165 * sequences, they will be tidied if and when they are
166 * passed to a mode parser.
167 * @param modeletter The mode letter to insert
168 * @param parameter The parameter for the mode
170 void Push(char modeletter, const std::string ¶meter);
171 /** Push a modeletter without parameter onto the stack.
172 * No checking is performed as to if this mode actually
173 * requires a parameter. If you stack invalid mode
174 * sequences, they will be tidied if and when they are
175 * passed to a mode parser.
176 * @param modeletter The mode letter to insert
178 void Push(char modeletter);
179 /** Push a '+' symbol onto the stack.
182 /** Push a '-' symbol onto the stack.
185 /** Return zero or more elements which form the
186 * mode line. This will be clamped to a max of
187 * MAXMODES+1 items (MAXMODES mode parameters and
188 * one mode sequence string).
189 * @param result The deque to populate. This will
190 * be cleared before it is used.
191 * @return The number of elements in the deque
193 int GetStackedLine(std::deque<std::string> &result);
196 /** irc::tokenstream reads a string formatted as per RFC1459 and RFC2812.
197 * It will split the string into 'tokens' each containing one parameter
199 * For instance, if it is instantiated with the string:
200 * "PRIVMSG #test :foo bar baz qux"
201 * then each successive call to tokenstream::GetToken() will return
202 * "PRIVMSG", "#test", "foo bar baz qux", "".
203 * Note that if the whole string starts with a colon this is not taken
204 * to mean the string is all one parameter, and the first item in the
205 * list will be ":item". This is to allow for parsing 'source' fields
214 /** Last position of a seperator token
216 std::string::iterator last_starting_position;
217 /** Current string position
219 std::string::iterator n;
220 /** True if the last value was an ending value
224 /** Create a tokenstream and fill it with the provided data
226 tokenstream(const std::string &source);
229 /** Fetch the next token from the stream
230 * @return The next token is returned, or an empty string if none remain
232 const std::string GetToken();
235 /** irc::sepstream allows for splitting token seperated lists.
236 * Each successive call to sepstream::GetToken() returns
237 * the next token, until none remain, at which point the method returns
240 class sepstream : public classbase
246 /** Last position of a seperator token
248 std::string::iterator last_starting_position;
249 /** Current string position
251 std::string::iterator n;
256 /** Create a sepstream and fill it with the provided data
258 sepstream(const std::string &source, char seperator);
259 virtual ~sepstream();
261 /** Fetch the next token from the stream
262 * @return The next token is returned, or an empty string if none remain
264 virtual const std::string GetToken();
266 /** Returns true if the end of the stream has been reached
267 * @return True if the end of the stream has been reached, otherwise false
269 virtual bool StreamEnd();
272 /** A derived form of sepstream, which seperates on commas
274 class commasepstream : public sepstream
277 commasepstream(const std::string &source) : sepstream(source, ',')
282 /** A derived form of sepstream, which seperates on spaces
284 class spacesepstream : public sepstream
287 spacesepstream(const std::string &source) : sepstream(source, ' ')
292 /** The portparser class seperates out a port range into integers.
293 * A port range may be specified in the input string in the form
294 * "6660,6661,6662-6669,7020". The end of the stream is indicated by
295 * a return value of 0 from portparser::GetToken(). If you attempt
296 * to specify an illegal range (e.g. one where start >= end, or
297 * start or end < 0) then GetToken() will return the first element
298 * of the pair of numbers.
300 class portparser : public classbase
303 /** Used to split on commas
306 /** Current position in a range of ports
309 /** Starting port in a range of ports
312 /** Ending port in a range of ports
315 /** Allow overlapped port ranges
318 /** Used to determine overlapping of ports
319 * without O(n) algorithm being used
321 std::map<long, bool> overlap_set;
322 /** Returns true if val overlaps an existing range
324 bool Overlaps(long val);
326 /** Create a portparser and fill it with the provided data
327 * @param source The source text to parse from
328 * @param allow_overlapped Allow overlapped ranges
330 portparser(const std::string &source, bool allow_overlapped = true);
331 /** Frees the internal commasepstream object
334 /** Fetch the next token from the stream
335 * @return The next port number is returned, or 0 if none remain
340 /** Used to hold a bitfield definition in dynamicbitmask.
341 * You must be allocated one of these by dynamicbitmask::Allocate(),
342 * you should not fill the values yourself!
344 typedef std::pair<size_t, unsigned char> bitfield;
346 /** The irc::dynamicbitmask class is used to maintain a bitmap of
347 * boolean values, which can grow to any reasonable size no matter
348 * how many bitfields are in it.
350 * It starts off at 32 bits in size, large enough to hold 32 boolean
351 * values, with a memory allocation of 8 bytes. If you allocate more
352 * than 32 bits, the class will grow the bitmap by 8 bytes at a time
353 * for each set of 8 bitfields you allocate with the Allocate()
356 * This method is designed so that multiple modules can be allocated
357 * bit values in a bitmap dynamically, rather than having to define
358 * costs in a fixed size unsigned integer and having the possibility
359 * of collisions of values in different third party modules.
363 * To use this class, you must derive from it.
364 * This is because each derived instance has its own freebits array
365 * which can determine what bitfields are allocated on a TYPE BY TYPE
366 * basis, e.g. an irc::dynamicbitmask type for userrecs, and one for
367 * chanrecs, etc. You should inheret it in a very simple way as follows.
368 * The base class will resize and maintain freebits as required, you are
369 * just required to make the pointer static and specific to this class
373 * class mydbitmask : public irc::dynamicbitmask
377 * static unsigned char* freebits;
381 * mydbitmask() : irc::dynamicbitmask()
383 * freebits = new unsigned char[this->bits_size];
384 * memset(freebits, 0, this->bits_size);
392 * unsigned char* GetFreeBits()
397 * void SetFreeBits(unsigned char* freebt)
404 class dynamicbitmask : public classbase
407 /** Data bits. We start with four of these,
408 * and we grow the bitfield as we allocate
409 * more than 32 entries with Allocate().
413 /** Current set size (size of freebits and bits).
414 * Both freebits and bits will ALWAYS be the
417 unsigned char bits_size;
419 /** Allocate the initial memory for bits and
420 * freebits and zero the memory.
424 /** Free the memory used by bits and freebits
426 virtual ~dynamicbitmask();
428 /** Allocate an irc::bitfield.
429 * @return An irc::bitfield which can be used
430 * with Get, Deallocate and Toggle methods.
431 * @throw Can throw std::bad_alloc if there is
432 * no ram left to grow the bitmask.
436 /** Deallocate an irc::bitfield.
437 * @param An irc::bitfield to deallocate.
438 * @return True if the bitfield could be
439 * deallocated, false if it could not.
441 bool Deallocate(bitfield &pos);
443 /** Toggle the value of a bitfield.
444 * @param pos A bitfield to allocate, previously
445 * allocated by dyamicbitmask::Allocate().
446 * @param state The state to set the field to.
448 void Toggle(bitfield &pos, bool state);
450 /** Get the value of a bitfield.
451 * @param pos A bitfield to retrieve, previously
452 * allocated by dyamicbitmask::Allocate().
453 * @return The value of the bitfield.
454 * @throw Will throw ModuleException if the bitfield
455 * you provide is outside of the range
456 * 0 >= bitfield.first < size_bits.
458 bool Get(bitfield &pos);
460 /** Return the size in bytes allocated to the bits
462 * Note that the actual allocation is twice this,
463 * as there are an equal number of bytes allocated
464 * for the freebits array.
466 unsigned char GetSize();
468 virtual unsigned char* GetFreeBits() { return NULL; }
470 virtual void SetFreeBits(unsigned char* freebits) { }
473 /** The irc_char_traits class is used for RFC-style comparison of strings.
474 * This class is used to implement irc::string, a case-insensitive, RFC-
475 * comparing string class.
477 struct irc_char_traits : std::char_traits<char> {
479 /** Check if two chars match
481 static bool eq(char c1st, char c2nd);
483 /** Check if two chars do NOT match
485 static bool ne(char c1st, char c2nd);
487 /** Check if one char is less than another
489 static bool lt(char c1st, char c2nd);
491 /** Compare two strings of size n
493 static int compare(const char* str1, const char* str2, size_t n);
495 /** Find a char within a string up to position n
497 static const char* find(const char* s1, int n, char c);
500 std::string hex(const unsigned char *raw, size_t rawsz);
502 /** This typedef declares irc::string based upon irc_char_traits
504 typedef basic_string<char, irc_char_traits, allocator<char> > string;
506 const char* Spacify(const char* n);
509 /* Define operators for using >> and << with irc::string to an ostream on an istream. */
510 /* This was endless fun. No. Really. */
511 /* It was also the first core change Ommeh made, if anyone cares */
512 std::ostream& operator<<(std::ostream &os, const irc::string &str);
513 std::istream& operator>>(std::istream &is, irc::string &str);
515 /* Define operators for + and == with irc::string to std::string for easy assignment
516 * and comparison - Brain
518 std::string operator+ (std::string& leftval, irc::string& rightval);
519 irc::string operator+ (irc::string& leftval, std::string& rightval);
520 bool operator== (std::string& leftval, irc::string& rightval);
521 bool operator== (irc::string& leftval, std::string& rightval);
523 std::string assign(const irc::string &other);
524 irc::string assign(const std::string &other);
528 /** Hashing function to hash irc::string
530 template<> struct hash<irc::string>
532 size_t operator()(const irc::string &s) const;