2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2011 Adam <Adam@anope.org>
5 * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
6 * Copyright (C) 2007, 2009 Dennis Friis <peavey@inspircd.org>
7 * Copyright (C) 2005-2009 Craig Edwards <craigedwards@brainbox.cc>
8 * Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
9 * Copyright (C) 2008 Pippijn van Steenhoven <pip88nl@gmail.com>
11 * This file is part of InspIRCd. InspIRCd is free software: you can
12 * redistribute it and/or modify it under the terms of the GNU General Public
13 * License as published by the Free Software Foundation, version 2.
15 * This program is distributed in the hope that it will be useful, but WITHOUT
16 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
17 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
20 * You should have received a copy of the GNU General Public License
21 * along with this program. If not, see <http://www.gnu.org/licenses/>.
35 /*******************************************************
36 * This file contains classes and templates that deal
37 * with the comparison and hashing of 'irc strings'.
38 * An 'irc string' is a string which compares in a
39 * case insensitive manner, and as per RFC 1459 will
40 * treat [ identical to {, ] identical to }, and \
43 * Our hashing functions are designed to accept
44 * std::string and compare/hash them as type irc::string
45 * by converting them internally. This makes them
46 * backwards compatible with other code which is not
47 * aware of irc::string.
48 *******************************************************/
50 /** Seperate from the other casemap tables so that code *can* still exclusively rely on RFC casemapping
53 * This is provided as a pointer so that modules can change it to their custom mapping tables,
54 * e.g. for national character support.
56 CoreExport extern unsigned const char *national_case_insensitive_map;
58 /** A mapping of uppercase to lowercase, including scandinavian
59 * 'oddities' as specified by RFC1459, e.g. { -> [, and | -> \
61 CoreExport extern unsigned const char rfc_case_insensitive_map[256];
63 /** Case insensitive map, ASCII rules.
67 CoreExport extern unsigned const char ascii_case_insensitive_map[256];
69 /** Case sensitive (identity) map.
71 CoreExport extern unsigned const char rfc_case_sensitive_map[256];
73 template<typename T> const T& SearchAndReplace(T& text, const T& pattern, const T& replace)
76 if ((!pattern.empty()) && (!text.empty()))
78 for (std::string::size_type n = 0; n != text.length(); ++n)
80 if (text.length() >= pattern.length() && text.substr(n, pattern.length()) == pattern)
82 /* Found the pattern in the text, replace it, and advance */
83 replacement.append(replace);
84 n = n + pattern.length() - 1;
88 replacement += text[n];
96 /** The irc namespace contains a number of helper classes.
101 /** This class returns true if two strings match.
102 * Case sensitivity is ignored, and the RFC 'character set'
105 struct CoreExport StrHashComp
107 /** The operator () does the actual comparison in hash_map
109 bool operator()(const std::string& s1, const std::string& s2) const;
114 size_t CoreExport operator()(const std::string &s) const;
117 /** The irc_char_traits class is used for RFC-style comparison of strings.
118 * This class is used to implement irc::string, a case-insensitive, RFC-
119 * comparing string class.
121 struct irc_char_traits : std::char_traits<char> {
123 /** Check if two chars match.
124 * @param c1st First character
125 * @param c2nd Second character
126 * @return true if the characters are equal
128 static bool eq(char c1st, char c2nd);
130 /** Check if two chars do NOT match.
131 * @param c1st First character
132 * @param c2nd Second character
133 * @return true if the characters are unequal
135 static bool ne(char c1st, char c2nd);
137 /** Check if one char is less than another.
138 * @param c1st First character
139 * @param c2nd Second character
140 * @return true if c1st is less than c2nd
142 static bool lt(char c1st, char c2nd);
144 /** Compare two strings of size n.
145 * @param str1 First string
146 * @param str2 Second string
147 * @param n Length to compare to
148 * @return similar to strcmp, zero for equal, less than zero for str1
149 * being less and greater than zero for str1 being greater than str2.
151 static CoreExport int compare(const char* str1, const char* str2, size_t n);
153 /** Find a char within a string up to position n.
154 * @param s1 String to find in
155 * @param n Position to search up to
156 * @param c Character to search for
157 * @return Pointer to the first occurance of c in s1
159 static CoreExport const char* find(const char* s1, int n, char c);
162 /** This typedef declares irc::string based upon irc_char_traits.
164 typedef std::basic_string<char, irc_char_traits, std::allocator<char> > string;
166 /** irc::stringjoiner joins string lists into a string, using
167 * the given seperator string.
168 * This class can join a vector of std::string, a deque of
169 * std::string, or a const char* const* array, using overloaded
172 class CoreExport stringjoiner
182 /** Join elements of a vector, 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
188 stringjoiner(const std::string &seperator, const std::vector<std::string> &sequence, int begin, int end);
190 /** Join elements of a deque, between (and including) begin and end
191 * @param seperator The string to seperate values with
192 * @param sequence One or more items to seperate
193 * @param begin The starting element in the sequence to be joined
194 * @param end The ending element in the sequence to be joined
196 stringjoiner(const std::string &seperator, const std::deque<std::string> &sequence, int begin, int end);
198 /** Join elements of an array of char arrays, between (and including) begin and end
199 * @param seperator The string to seperate values with
200 * @param sequence One or more items to seperate
201 * @param begin The starting element in the sequence to be joined
202 * @param end The ending element in the sequence to be joined
204 stringjoiner(const std::string &seperator, const char* const* sequence, int begin, int end);
206 /** Get the joined sequence
207 * @return A reference to the joined string
209 std::string& GetJoined();
212 /** irc::modestacker stacks mode sequences into a list.
213 * It can then reproduce this list, clamped to a maximum of MAXMODES
216 class CoreExport modestacker
219 /** The mode sequence and its parameters
221 std::deque<std::string> sequence;
223 /** True if the mode sequence is initially adding
224 * characters, false if it is initially removing
230 /** Construct a new modestacker.
231 * @param add True if the stack is adding modes,
232 * false if it is removing them
234 modestacker(bool add);
236 /** Push a modeletter and its parameter onto the stack.
237 * No checking is performed as to if this mode actually
238 * requires a parameter. If you stack invalid mode
239 * sequences, they will be tidied if and when they are
240 * passed to a mode parser.
241 * @param modeletter The mode letter to insert
242 * @param parameter The parameter for the mode
244 void Push(char modeletter, const std::string ¶meter);
246 /** Push a modeletter without parameter onto the stack.
247 * No checking is performed as to if this mode actually
248 * requires a parameter. If you stack invalid mode
249 * sequences, they will be tidied if and when they are
250 * passed to a mode parser.
251 * @param modeletter The mode letter to insert
253 void Push(char modeletter);
255 /** Push a '+' symbol onto the stack.
259 /** Push a '-' symbol onto the stack.
263 /** Return zero or more elements which form the
264 * mode line. This will be clamped to a max of
265 * MAXMODES items (MAXMODES-1 mode parameters and
266 * one mode sequence string), and max_line_size
267 * characters. As specified below, this function
268 * should be called in a loop until it returns zero,
269 * indicating there are no more modes to return.
270 * @param result The vector to populate. This will not
271 * be cleared before it is used.
272 * @param max_line_size The maximum size of the line
273 * to build, in characters, seperate to MAXMODES.
274 * @return The number of elements in the deque.
275 * The function should be called repeatedly until it
276 * returns 0, in case there are multiple lines of
277 * mode changes to be obtained.
279 int GetStackedLine(std::vector<std::string> &result, int max_line_size = 360);
283 /** irc::tokenstream reads a string formatted as per RFC1459 and RFC2812.
284 * It will split the string into 'tokens' each containing one parameter
286 * For instance, if it is instantiated with the string:
287 * "PRIVMSG #test :foo bar baz qux"
288 * then each successive call to tokenstream::GetToken() will return
289 * "PRIVMSG", "#test", "foo bar baz qux", "".
290 * Note that if the whole string starts with a colon this is not taken
291 * to mean the string is all one parameter, and the first item in the
292 * list will be ":item". This is to allow for parsing 'source' fields
295 class CoreExport tokenstream
303 /** Last position of a seperator token
305 std::string::iterator last_starting_position;
307 /** Current string position
309 std::string::iterator n;
311 /** True if the last value was an ending value
316 /** Create a tokenstream and fill it with the provided data
318 tokenstream(const std::string &source);
324 /** Fetch the next token from the stream as a std::string
325 * @param token The next token available, or an empty string if none remain
326 * @return True if tokens are left to be read, false if the last token was just retrieved.
328 bool GetToken(std::string &token);
330 /** Fetch the next token from the stream as an irc::string
331 * @param token The next token available, or an empty string if none remain
332 * @return True if tokens are left to be read, false if the last token was just retrieved.
334 bool GetToken(irc::string &token);
336 /** Fetch the next token from the stream as an integer
337 * @param token The next token available, or undefined if none remain
338 * @return True if tokens are left to be read, false if the last token was just retrieved.
340 bool GetToken(int &token);
342 /** Fetch the next token from the stream as a long integer
343 * @param token The next token available, or undefined if none remain
344 * @return True if tokens are left to be read, false if the last token was just retrieved.
346 bool GetToken(long &token);
349 /** irc::sepstream allows for splitting token seperated lists.
350 * Each successive call to sepstream::GetToken() returns
351 * the next token, until none remain, at which point the method returns
354 class CoreExport sepstream
360 /** Last position of a seperator token
362 std::string::iterator last_starting_position;
363 /** Current string position
365 std::string::iterator n;
370 /** Create a sepstream and fill it with the provided data
372 sepstream(const std::string &source, char seperator);
376 virtual ~sepstream();
378 /** Fetch the next token from the stream
379 * @param token The next token from the stream is placed here
380 * @return True if tokens still remain, false if there are none left
382 virtual bool GetToken(std::string &token);
384 /** Fetch the entire remaining stream, without tokenizing
385 * @return The remaining part of the stream
387 virtual const std::string GetRemaining();
389 /** Returns true if the end of the stream has been reached
390 * @return True if the end of the stream has been reached, otherwise false
392 virtual bool StreamEnd();
395 /** A derived form of sepstream, which seperates on commas
397 class CoreExport commasepstream : public sepstream
400 /** Initialize with comma seperator
402 commasepstream(const std::string &source) : sepstream(source, ',')
407 /** A derived form of sepstream, which seperates on spaces
409 class CoreExport spacesepstream : public sepstream
412 /** Initialize with space seperator
414 spacesepstream(const std::string &source) : sepstream(source, ' ')
419 /** The portparser class seperates out a port range into integers.
420 * A port range may be specified in the input string in the form
421 * "6660,6661,6662-6669,7020". The end of the stream is indicated by
422 * a return value of 0 from portparser::GetToken(). If you attempt
423 * to specify an illegal range (e.g. one where start >= end, or
424 * start or end < 0) then GetToken() will return the first element
425 * of the pair of numbers.
427 class CoreExport portparser
431 /** Used to split on commas
435 /** Current position in a range of ports
439 /** Starting port in a range of ports
443 /** Ending port in a range of ports
447 /** Allow overlapped port ranges
451 /** Used to determine overlapping of ports
452 * without O(n) algorithm being used
454 std::set<long> overlap_set;
456 /** Returns true if val overlaps an existing range
458 bool Overlaps(long val);
461 /** Create a portparser and fill it with the provided data
462 * @param source The source text to parse from
463 * @param allow_overlapped Allow overlapped ranges
465 portparser(const std::string &source, bool allow_overlapped = true);
467 /** Fetch the next token from the stream
468 * @return The next port number is returned, or 0 if none remain
475 /** Hash an irc::string using RFC1459 case sensitivity rules
476 * @param s A string to hash
477 * @return The hash value
479 size_t CoreExport operator()(const irc::string &s) const;
483 /* Define operators for using >> and << with irc::string to an ostream on an istream. */
484 /* This was endless fun. No. Really. */
485 /* It was also the first core change Ommeh made, if anyone cares */
487 /** Operator << for irc::string
489 inline std::ostream& operator<<(std::ostream &os, const irc::string &str) { return os << str.c_str(); }
491 /** Operator >> for irc::string
493 inline std::istream& operator>>(std::istream &is, irc::string &str)
501 /* Define operators for + and == with irc::string to std::string for easy assignment
506 inline std::string operator+ (std::string& leftval, irc::string& rightval)
508 return leftval + std::string(rightval.c_str());
511 /* Define operators for + and == with irc::string to std::string for easy assignment
516 inline irc::string operator+ (irc::string& leftval, std::string& rightval)
518 return leftval + irc::string(rightval.c_str());
521 /* Define operators for + and == with irc::string to std::string for easy assignment
526 inline bool operator== (const std::string& leftval, const irc::string& rightval)
528 return (leftval.c_str() == rightval);
531 /* Define operators for + and == with irc::string to std::string for easy assignment
536 inline bool operator== (const irc::string& leftval, const std::string& rightval)
538 return (leftval == rightval.c_str());
541 /* Define operators != for irc::string to std::string for easy comparison
543 inline bool operator!= (const irc::string& leftval, const std::string& rightval)
545 return !(leftval == rightval.c_str());
548 /* Define operators != for std::string to irc::string for easy comparison
550 inline bool operator!= (const std::string& leftval, const irc::string& rightval)
552 return !(leftval.c_str() == rightval);
555 /** Assign an irc::string to a std::string.
557 inline std::string assign(const irc::string &other) { return other.c_str(); }
559 /** Assign a std::string to an irc::string.
561 inline irc::string assign(const std::string &other) { return other.c_str(); }
563 /** Trim the leading and trailing spaces from a std::string.
565 inline std::string& trim(std::string &str)
567 std::string::size_type start = str.find_first_not_of(" ");
568 std::string::size_type end = str.find_last_not_of(" ");
569 if (start == std::string::npos || end == std::string::npos)
572 str = str.substr(start, end-start+1);