]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - include/hashcomp.h
Document ENCAP.
[user/henk/code/inspircd.git] / include / hashcomp.h
1 /*       +------------------------------------+
2  *       | Inspire Internet Relay Chat Daemon |
3  *       +------------------------------------+
4  *
5  *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
6  * See: http://www.inspircd.org/wiki/index.php/Credits
7  *
8  * This program is free but copyrighted software; see
9  *          the file COPYING for details.
10  *
11  * ---------------------------------------------------
12  */
13
14 #ifndef _HASHCOMP_H_
15 #define _HASHCOMP_H_
16
17 #include <cstring>
18 #include "hash_map.h"
19
20 /*******************************************************
21  * This file contains classes and templates that deal
22  * with the comparison and hashing of 'irc strings'.
23  * An 'irc string' is a string which compares in a
24  * case insensitive manner, and as per RFC 1459 will
25  * treat [ identical to {, ] identical to }, and \
26  * as identical to |.
27  *
28  * Our hashing functions are designed  to accept
29  * std::string and compare/hash them as type irc::string
30  * by converting them internally. This makes them
31  * backwards compatible with other code which is not
32  * aware of irc::string.
33  *******************************************************/
34
35 #ifndef LOWERMAP
36 #define LOWERMAP
37
38 /** A mapping of uppercase to lowercase, including scandinavian
39  * 'oddities' as specified by RFC1459, e.g. { -> [, and | -> \
40  */
41 unsigned const char rfc_case_insensitive_map[256] = {
42         0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19,                                   /* 0-19 */
43         20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39,                         /* 20-39 */
44         40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59,                         /* 40-59 */
45         60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111,             /* 60-79 */
46         112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 94, 95, 96, 97, 98, 99,           /* 80-99 */
47         100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119,     /* 100-119 */
48         120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139,     /* 120-139 */
49         140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159,     /* 140-159 */
50         160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179,     /* 160-179 */
51         180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199,     /* 180-199 */
52         200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219,     /* 200-219 */
53         220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239,     /* 220-239 */
54         240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254, 255                          /* 240-255 */
55 };
56
57 /**
58  * Case sensitive map. As per rfc_case_insensitive_map, but case sensitive. duh.
59  */
60 unsigned const char case_sensitive_map[256] = {
61         0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20,
62         21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40,
63         41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60,
64         61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80,
65         81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100,
66         101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120,
67         121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140,
68         141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160,
69         161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180,
70         181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200,
71         201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220,
72         221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240,
73         241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254, 255
74 };
75
76 #endif
77
78 /** The irc namespace contains a number of helper classes.
79  */
80 namespace irc
81 {
82
83         /** This class returns true if two strings match.
84          * Case sensitivity is ignored, and the RFC 'character set'
85          * is adhered to
86          */
87         struct StrHashComp
88         {
89                 /** The operator () does the actual comparison in hash_map
90                  */
91                 bool operator()(const std::string& s1, const std::string& s2) const;
92         };
93
94         /** The irc_char_traits class is used for RFC-style comparison of strings.
95          * This class is used to implement irc::string, a case-insensitive, RFC-
96          * comparing string class.
97          */
98         struct irc_char_traits : std::char_traits<char> {
99
100                 /** Check if two chars match.
101                  * @param c1st First character
102                  * @param c2nd Second character
103                  * @return true if the characters are equal
104                  */
105                 static bool eq(char c1st, char c2nd);
106
107                 /** Check if two chars do NOT match.
108                  * @param c1st First character
109                  * @param c2nd Second character
110                  * @return true if the characters are unequal
111                  */
112                 static bool ne(char c1st, char c2nd);
113
114                 /** Check if one char is less than another.
115                  * @param c1st First character
116                  * @param c2nd Second character
117                  * @return true if c1st is less than c2nd
118                  */
119                 static bool lt(char c1st, char c2nd);
120
121                 /** Compare two strings of size n.
122                  * @param str1 First string
123                  * @param str2 Second string
124                  * @param n Length to compare to
125                  * @return similar to strcmp, zero for equal, less than zero for str1
126                  * being less and greater than zero for str1 being greater than str2.
127                  */
128                 static CoreExport int compare(const char* str1, const char* str2, size_t n);
129
130                 /** Find a char within a string up to position n.
131                  * @param s1 String to find in
132                  * @param n Position to search up to
133                  * @param c Character to search for
134                  * @return Pointer to the first occurance of c in s1
135                  */
136                 static CoreExport const char* find(const char* s1, int  n, char c);
137         };
138
139         /** Compose a hex string from raw data.
140          * @param raw The raw data to compose hex from
141          * @pram rawsz The size of the raw data buffer
142          * @return The hex string.
143          */
144         CoreExport std::string hex(const unsigned char *raw, size_t rawsz);
145
146         /** This typedef declares irc::string based upon irc_char_traits.
147          */
148         typedef std::basic_string<char, irc_char_traits, std::allocator<char> > string;
149
150         /** irc::stringjoiner joins string lists into a string, using
151          * the given seperator string.
152          * This class can join a vector of std::string, a deque of
153          * std::string, or a const char* const* array, using overloaded
154          * constructors.
155          */
156         class CoreExport stringjoiner : public classbase
157         {
158          private:
159
160                 /** Output string
161                  */
162                 std::string joined;
163
164          public:
165
166                 /** Join elements of a vector, between (and including) begin and end
167                  * @param seperator The string to seperate values with
168                  * @param sequence One or more items to seperate
169                  * @param begin The starting element in the sequence to be joined
170                  * @param end The ending element in the sequence to be joined
171                  */
172                 stringjoiner(const std::string &seperator, const std::vector<std::string> &sequence, int begin, int end);
173
174                 /** Join elements of a deque, between (and including) begin and end
175                  * @param seperator The string to seperate values with
176                  * @param sequence One or more items to seperate
177                  * @param begin The starting element in the sequence to be joined
178                  * @param end The ending element in the sequence to be joined
179                  */
180                 stringjoiner(const std::string &seperator, const std::deque<std::string> &sequence, int begin, int end);
181
182                 /** Join elements of an array of char arrays, between (and including) begin and end
183                  * @param seperator The string to seperate values with
184                  * @param sequence One or more items to seperate
185                  * @param begin The starting element in the sequence to be joined
186                  * @param end The ending element in the sequence to be joined
187                  */
188                 stringjoiner(const std::string &seperator, const char* const* sequence, int begin, int end);
189
190                 /** Get the joined sequence
191                  * @return A reference to the joined string
192                  */
193                 std::string& GetJoined();
194         };
195
196         /** irc::modestacker stacks mode sequences into a list.
197          * It can then reproduce this list, clamped to a maximum of MAXMODES
198          * values per line.
199          */
200         class CoreExport modestacker : public classbase
201         {
202          private:
203                 InspIRCd* ServerInstance;
204
205                 /** The mode sequence and its parameters
206                  */
207                 std::deque<std::string> sequence;
208
209                 /** True if the mode sequence is initially adding
210                  * characters, false if it is initially removing
211                  * them
212                  */
213                 bool adding;
214          public:
215
216                 /** Construct a new modestacker.
217                  * @param add True if the stack is adding modes,
218                  * false if it is removing them
219                  */
220                 modestacker(InspIRCd* Instance, bool add);
221
222                 /** Push a modeletter and its parameter onto the stack.
223                  * No checking is performed as to if this mode actually
224                  * requires a parameter. If you stack invalid mode
225                  * sequences, they will be tidied if and when they are
226                  * passed to a mode parser.
227                  * @param modeletter The mode letter to insert
228                  * @param parameter The parameter for the mode
229                  */
230                 void Push(char modeletter, const std::string &parameter);
231
232                 /** Push a modeletter without parameter onto the stack.
233                  * No checking is performed as to if this mode actually
234                  * requires a parameter. If you stack invalid mode
235                  * sequences, they will be tidied if and when they are
236                  * passed to a mode parser.
237                  * @param modeletter The mode letter to insert
238                  */
239                 void Push(char modeletter);
240         
241                 /** Push a '+' symbol onto the stack.
242                  */
243                 void PushPlus();
244         
245                 /** Push a '-' symbol onto the stack.
246                  */
247                 void PushMinus();
248                 
249                 /** Return zero or more elements which form the
250                  * mode line. This will be clamped to a max of
251                  * MAXMODES items (MAXMODES-1 mode parameters and
252                  * one mode sequence string), and max_line_size
253                  * characters. As specified below, this function
254                  * should be called in a loop until it returns zero,
255                  * indicating there are no more modes to return.
256                  * @param result The deque to populate. This will
257                  * be cleared before it is used.
258                  * @param max_line_size The maximum size of the line
259                  * to build, in characters, seperate to MAXMODES.
260                  * @return The number of elements in the deque.
261                  * The function should be called repeatedly until it
262                  * returns 0, in case there are multiple lines of
263                  * mode changes to be obtained.
264                  */
265                 int GetStackedLine(std::deque<std::string> &result, int max_line_size = 360);
266         };
267
268         /** irc::tokenstream reads a string formatted as per RFC1459 and RFC2812.
269          * It will split the string into 'tokens' each containing one parameter
270          * from the string.
271          * For instance, if it is instantiated with the string:
272          * "PRIVMSG #test :foo bar baz qux"
273          * then each successive call to tokenstream::GetToken() will return
274          * "PRIVMSG", "#test", "foo bar baz qux", "".
275          * Note that if the whole string starts with a colon this is not taken
276          * to mean the string is all one parameter, and the first item in the
277          * list will be ":item". This is to allow for parsing 'source' fields
278          * from data.
279          */
280         class CoreExport tokenstream : public classbase
281         {
282          private:
283         
284                 /** Original string
285                  */
286                 std::string tokens;
287
288                 /** Last position of a seperator token
289                  */
290                 std::string::iterator last_starting_position;
291
292                 /** Current string position
293                  */
294                 std::string::iterator n;
295
296                 /** True if the last value was an ending value
297                  */
298                 bool last_pushed;
299          public:
300
301                 /** Create a tokenstream and fill it with the provided data
302                  */
303                 tokenstream(const std::string &source);
304
305                 /** Destructor
306                  */
307                 ~tokenstream();
308
309                 /** Fetch the next token from the stream as a std::string
310                  * @param token The next token available, or an empty string if none remain
311                  * @return True if tokens are left to be read, false if the last token was just retrieved.
312                  */
313                 bool GetToken(std::string &token);
314
315                 /** Fetch the next token from the stream as an irc::string
316                  * @param token The next token available, or an empty string if none remain
317                  * @return True if tokens are left to be read, false if the last token was just retrieved.
318                  */
319                 bool GetToken(irc::string &token);
320
321                 /** Fetch the next token from the stream as an integer
322                  * @param token The next token available, or undefined if none remain
323                  * @return True if tokens are left to be read, false if the last token was just retrieved.
324                  */
325                 bool GetToken(int &token);
326
327                 /** Fetch the next token from the stream as a long integer
328                  * @param token The next token available, or undefined if none remain
329                  * @return True if tokens are left to be read, false if the last token was just retrieved.
330                  */
331                 bool GetToken(long &token);
332         };
333
334         /** irc::sepstream allows for splitting token seperated lists.
335          * Each successive call to sepstream::GetToken() returns
336          * the next token, until none remain, at which point the method returns
337          * an empty string.
338          */
339         class CoreExport sepstream : public classbase
340         {
341          private:
342                 /** Original string.
343                  */
344                 std::string tokens;
345                 /** Last position of a seperator token
346                  */
347                 std::string::iterator last_starting_position;
348                 /** Current string position
349                  */
350                 std::string::iterator n;
351                 /** Seperator value
352                  */
353                 char sep;
354          public:
355                 /** Create a sepstream and fill it with the provided data
356                  */
357                 sepstream(const std::string &source, char seperator);
358
359                 /** Destructor
360                  */
361                 virtual ~sepstream();
362
363                 /** Fetch the next token from the stream
364                  * @param token The next token from the stream is placed here
365                  * @return True if tokens still remain, false if there are none left
366                  */
367                 virtual bool GetToken(std::string &token);
368
369                 /** Fetch the entire remaining stream, without tokenizing
370                  * @return The remaining part of the stream
371                  */
372                 virtual const std::string GetRemaining();
373
374                 /** Returns true if the end of the stream has been reached
375                  * @return True if the end of the stream has been reached, otherwise false
376                  */
377                 virtual bool StreamEnd();
378         };
379
380         /** A derived form of sepstream, which seperates on commas
381          */
382         class CoreExport commasepstream : public sepstream
383         {
384          public:
385                 /** Initialize with comma seperator
386                  */
387                 commasepstream(const std::string &source) : sepstream(source, ',')
388                 {
389                 }
390         };
391
392         /** A derived form of sepstream, which seperates on spaces
393          */
394         class CoreExport spacesepstream : public sepstream
395         {
396          public:
397                 /** Initialize with space seperator
398                  */
399                 spacesepstream(const std::string &source) : sepstream(source, ' ')
400                 {
401                 }
402         };
403
404         /** The portparser class seperates out a port range into integers.
405          * A port range may be specified in the input string in the form
406          * "6660,6661,6662-6669,7020". The end of the stream is indicated by
407          * a return value of 0 from portparser::GetToken(). If you attempt
408          * to specify an illegal range (e.g. one where start >= end, or
409          * start or end < 0) then GetToken() will return the first element
410          * of the pair of numbers.
411          */
412         class CoreExport portparser : public classbase
413         {
414          private:
415
416                 /** Used to split on commas
417                  */
418                 commasepstream* sep;
419         
420                 /** Current position in a range of ports
421                  */
422                 long in_range;
423         
424                 /** Starting port in a range of ports
425                  */
426                 long range_begin;
427         
428                 /** Ending port in a range of ports
429                  */
430                 long range_end;
431         
432                 /** Allow overlapped port ranges
433                  */
434                 bool overlapped;
435         
436                 /** Used to determine overlapping of ports
437                  * without O(n) algorithm being used
438                  */
439                 std::map<long, bool> overlap_set;
440         
441                 /** Returns true if val overlaps an existing range
442                  */
443                 bool Overlaps(long val);
444          public:
445         
446                 /** Create a portparser and fill it with the provided data
447                  * @param source The source text to parse from
448                  * @param allow_overlapped Allow overlapped ranges
449                  */
450                 portparser(const std::string &source, bool allow_overlapped = true);
451         
452                 /** Frees the internal commasepstream object
453                  */
454                 ~portparser();
455         
456                 /** Fetch the next token from the stream
457                  * @return The next port number is returned, or 0 if none remain
458                  */
459                 long GetToken();
460         };
461
462         /** Turn _ characters in a string into spaces
463          * @param n String to translate
464          * @return The new value with _ translated to space.
465          */
466         CoreExport const char* Spacify(const char* n);
467 }
468
469 /* Define operators for using >> and << with irc::string to an ostream on an istream. */
470 /* This was endless fun. No. Really. */
471 /* It was also the first core change Ommeh made, if anyone cares */
472
473 /** Operator << for irc::string
474  */
475 inline std::ostream& operator<<(std::ostream &os, const irc::string &str) { return os << str.c_str(); }
476
477 /** Operator >> for irc::string
478  */
479 inline std::istream& operator>>(std::istream &is, irc::string &str)
480 {
481         std::string tmp;
482         is >> tmp;
483         str = tmp.c_str();
484         return is;
485 }
486
487 /* Define operators for + and == with irc::string to std::string for easy assignment
488  * and comparison
489  *
490  * Operator +
491  */
492 inline std::string operator+ (std::string& leftval, irc::string& rightval)
493 {
494         return leftval + std::string(rightval.c_str());
495 }
496
497 /* Define operators for + and == with irc::string to std::string for easy assignment
498  * and comparison
499  *
500  * Operator +
501  */
502 inline irc::string operator+ (irc::string& leftval, std::string& rightval)
503 {
504         return leftval + irc::string(rightval.c_str());
505 }
506
507 /* Define operators for + and == with irc::string to std::string for easy assignment
508  * and comparison
509  *
510  * Operator ==
511  */
512 inline bool operator== (const std::string& leftval, const irc::string& rightval)
513 {
514         return (leftval.c_str() == rightval);
515 }
516
517 /* Define operators for + and == with irc::string to std::string for easy assignment
518  * and comparison
519  *
520  * Operator ==
521  */
522 inline bool operator== (const irc::string& leftval, const std::string& rightval)
523 {
524         return (leftval == rightval.c_str());
525 }
526
527 /* Define operators != for irc::string to std::string for easy comparison
528  */
529 inline bool operator!= (const irc::string& leftval, const std::string& rightval)
530 {
531         return !(leftval == rightval.c_str());
532 }
533
534 /* Define operators != for std::string to irc::string for easy comparison
535  */
536 inline bool operator!= (const std::string& leftval, const irc::string& rightval)
537 {
538         return !(leftval.c_str() == rightval);
539 }
540
541 // FIXME MAXBUF messes up these
542 #if 0
543 template<std::size_t N>
544 static inline bool operator == (std::string const &lhs, char const (&rhs)[N])
545 {
546         return lhs.length() == N - 1 && !std::memcmp(lhs.data(), rhs, N - 1);
547 }
548
549 template<std::size_t N>
550 static inline bool operator != (std::string const &lhs, char const (&rhs)[N])
551 {
552         return !(lhs == rhs);
553 }
554 #endif
555
556 /** Assign an irc::string to a std::string.
557  */
558 inline std::string assign(const irc::string &other) { return other.c_str(); }
559
560 /** Assign a std::string to an irc::string.
561  */
562 inline irc::string assign(const std::string &other) { return other.c_str(); }
563
564 /** Trim the leading and trailing spaces from a std::string.
565  */
566 inline std::string& trim(std::string &str)
567 {
568         std::string::size_type start = str.find_first_not_of(" ");
569         std::string::size_type end = str.find_last_not_of(" ");
570         if (start == std::string::npos || end == std::string::npos)
571                 str = "";
572         else
573                 str = str.substr(start, end-start+1);
574
575         return str;
576 }
577
578 /** Hashing stuff is totally different on vc++'s hash_map implementation, so to save a buttload of
579  * #ifdefs we'll just do it all at once
580  */
581 BEGIN_HASHMAP_NAMESPACE
582
583         /** Hashing function to hash irc::string
584          */
585 #ifdef WINDOWS
586         template<> class CoreExport hash_compare<irc::string, std::less<irc::string> >
587         {
588         public:
589                 enum { bucket_size = 4, min_buckets = 8 }; /* Got these numbers from the CRT source, if anyone wants to change them feel free. */
590
591                 /** Compare two irc::string values for hashing in hash_map
592                  */
593                 bool operator()(const irc::string & s1, const irc::string & s2) const
594                 {
595                         if(s1.length() != s2.length()) return true;
596                         return (irc::irc_char_traits::compare(s1.c_str(), s2.c_str(), (size_t)s1.length()) < 0);
597                 }
598
599                 /** Hash an irc::string value for hash_map
600                  */
601                 size_t operator()(const irc::string & s) const;
602         };
603
604         template<> class CoreExport hash_compare<std::string, std::less<std::string> >
605         {
606         public:
607                 enum { bucket_size = 4, min_buckets = 8 }; /* Again, from the CRT source */
608
609                 /** Compare two std::string values for hashing in hash_map
610                  */
611                 bool operator()(const std::string & s1, const std::string & s2) const
612                 {
613                         if(s1.length() != s2.length()) return true;
614                         return (irc::irc_char_traits::compare(s1.c_str(), s2.c_str(), (size_t)s1.length()) < 0);
615                 }
616
617                 /** Hash a std::string using RFC1459 case sensitivity rules
618                 * @param s A string to hash
619                 * @return The hash value
620                 */
621                 size_t operator()(const std::string & s) const;
622         };
623 #else
624
625         template<> struct hash<irc::string>
626         {
627                 /** Hash an irc::string using RFC1459 case sensitivity rules
628                  * @param s A string to hash
629                  * @return The hash value
630                  */
631                 size_t operator()(const irc::string &s) const;
632         };
633
634         /* XXX FIXME: Implement a hash function overriding std::string's that works with TR1! */
635
636 #ifdef HASHMAP_DEPRECATED
637         struct insensitive
638 #else
639         template<> struct hash<std::string>
640 #endif
641         {
642                 size_t operator()(const std::string &s) const;
643         };
644
645 #endif
646
647         /** Convert a string to lower case respecting RFC1459
648         * @param n A string to lowercase
649         */
650         void strlower(char *n);
651
652 END_HASHMAP_NAMESPACE
653
654 #endif
655