2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2019 linuxdaemon <linuxdaemon.irc@gmail.com>
5 * Copyright (C) 2013, 2018-2019 Sadie Powell <sadie@witchery.services>
6 * Copyright (C) 2013 Adam <Adam@anope.org>
7 * Copyright (C) 2012-2013, 2016 Attila Molnar <attilamolnar@hush.com>
8 * Copyright (C) 2012 Robby <robby@chatbelgie.be>
9 * Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org>
10 * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
11 * Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
12 * Copyright (C) 2008 Pippijn van Steenhoven <pip88nl@gmail.com>
13 * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
14 * Copyright (C) 2006-2010 Craig Edwards <brain@inspircd.org>
16 * This file is part of InspIRCd. InspIRCd is free software: you can
17 * redistribute it and/or modify it under the terms of the GNU General Public
18 * License as published by the Free Software Foundation, version 2.
20 * This program is distributed in the hope that it will be useful, but WITHOUT
21 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
22 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
25 * You should have received a copy of the GNU General Public License
26 * along with this program. If not, see <http://www.gnu.org/licenses/>.
41 /*******************************************************
42 * This file contains classes and templates that deal
43 * with the comparison and hashing of 'irc strings'.
44 * An 'irc string' is a string which compares in a
45 * case insensitive manner, and as per RFC 1459 will
46 * treat [ identical to {, ] identical to }, and \
49 * There are functors that accept std::string and
50 * compare/hash them as type irc::string by using
51 * mapping arrays internally.
52 *******************************************************/
54 /** Separate from the other casemap tables so that code *can* still exclusively rely on RFC casemapping
57 * This is provided as a pointer so that modules can change it to their custom mapping tables,
58 * e.g. for national character support.
60 CoreExport extern unsigned const char *national_case_insensitive_map;
62 /** A mapping of uppercase to lowercase, including scandinavian
63 * 'oddities' as specified by RFC1459, e.g. { -> [, and | -> \
65 CoreExport extern unsigned const char rfc_case_insensitive_map[256];
67 /** Case insensitive map, ASCII rules.
71 CoreExport extern unsigned const char ascii_case_insensitive_map[256];
73 /** The irc namespace contains a number of helper classes.
77 /** Check if two IRC object (e.g. nick or channel) names are equal.
78 * This function uses national_case_insensitive_map to determine equality, which, by default does comparison
79 * according to RFC 1459, treating certain otherwise non-identical characters as identical.
80 * @param s1 First string to compare
81 * @param s2 Second string to compare
82 * @return True if the two names are equal, false otherwise
84 CoreExport bool equals(const std::string& s1, const std::string& s2);
86 /** Check whether \p needle exists within \p haystack.
87 * @param haystack The string to search within.
88 * @param needle The string to search for.
89 * @return Either the index at which \p needle was found or std::string::npos.
91 CoreExport size_t find(const std::string& haystack, const std::string& needle);
93 /** This class returns true if two strings match.
94 * Case sensitivity is ignored, and the RFC 'character set'
99 /** The operator () does the actual comparison in hash_map
101 bool operator()(const std::string& s1, const std::string& s2) const
103 return equals(s1, s2);
109 size_t CoreExport operator()(const std::string &s) const;
112 struct insensitive_swo
114 bool CoreExport operator()(const std::string& a, const std::string& b) const;
117 /** irc::sepstream allows for splitting token separated lists.
118 * Each successive call to sepstream::GetToken() returns
119 * the next token, until none remain, at which point the method returns
122 class CoreExport sepstream
131 /** Current string position
134 /** If set then GetToken() can return an empty string
138 /** Create a sepstream and fill it with the provided data
140 sepstream(const std::string &source, char separator, bool allowempty = false);
142 /** Fetch the next token from the stream
143 * @param token The next token from the stream is placed here
144 * @return True if tokens still remain, false if there are none left
146 bool GetToken(std::string& token);
148 /** Fetch the next numeric token from the stream
149 * @param token The next token from the stream is placed here
150 * @return True if tokens still remain, false if there are none left
152 template<typename Numeric>
153 bool GetNumericToken(Numeric& token)
159 token = ConvToNum<Numeric>(str);
163 /** Fetch the entire remaining stream, without tokenizing
164 * @return The remaining part of the stream
166 const std::string GetRemaining();
168 /** Returns true if the end of the stream has been reached
169 * @return True if the end of the stream has been reached, otherwise false
173 /** Returns true if the specified value exists in the stream
174 * @param value The value to search for
175 * @return True if the value was found, False otherwise
177 bool Contains(const std::string& value);
180 /** A derived form of sepstream, which separates on commas
182 class CoreExport commasepstream : public sepstream
185 /** Initialize with comma separator
187 commasepstream(const std::string &source, bool allowempty = false) : sepstream(source, ',', allowempty)
192 /** A derived form of sepstream, which separates on spaces
194 class CoreExport spacesepstream : public sepstream
197 /** Initialize with space separator
199 spacesepstream(const std::string &source, bool allowempty = false) : sepstream(source, ' ', allowempty)
204 /** irc::tokenstream reads a string formatted as per RFC1459 and RFC2812.
205 * It will split the string into 'tokens' each containing one parameter
207 * For instance, if it is instantiated with the string:
208 * "PRIVMSG #test :foo bar baz qux"
209 * then each successive call to tokenstream::GetToken() will return
210 * "PRIVMSG", "#test", "foo bar baz qux", "".
211 * Note that if the whole string starts with a colon this is not taken
212 * to mean the string is all one parameter, and the first item in the
213 * list will be ":item". This is to allow for parsing 'source' fields
216 class CoreExport tokenstream
219 /** The message we are parsing tokens from. */
222 /** The current position within the message. */
226 /** Create a tokenstream and fill it with the provided data. */
227 tokenstream(const std::string& msg, size_t start = 0, size_t end = std::string::npos);
229 /** Retrieves the underlying message. */
230 std::string& GetMessage() { return message; }
232 /** Retrieve the next \<middle> token in the token stream.
233 * @param token The next token available, or an empty string if none remain.
234 * @return True if tokens are left to be read, false if the last token was just retrieved.
236 bool GetMiddle(std::string& token);
238 /** Retrieve the next \<trailing> token in the token stream.
239 * @param token The next token available, or an empty string if none remain.
240 * @return True if tokens are left to be read, false if the last token was just retrieved.
242 bool GetTrailing(std::string& token);
245 /** The portparser class separates out a port range into integers.
246 * A port range may be specified in the input string in the form
247 * "6660,6661,6662-6669,7020". The end of the stream is indicated by
248 * a return value of 0 from portparser::GetToken(). If you attempt
249 * to specify an illegal range (e.g. one where start >= end, or
250 * start or end < 0) then GetToken() will return the first element
251 * of the pair of numbers.
253 class CoreExport portparser
257 /** Used to split on commas
261 /** Current position in a range of ports
265 /** Starting port in a range of ports
269 /** Ending port in a range of ports
273 /** Allow overlapped port ranges
277 /** Used to determine overlapping of ports
278 * without O(n) algorithm being used
280 std::set<long> overlap_set;
282 /** Returns true if val overlaps an existing range
284 bool Overlaps(long val);
287 /** Create a portparser and fill it with the provided data
288 * @param source The source text to parse from
289 * @param allow_overlapped Allow overlapped ranges
291 portparser(const std::string &source, bool allow_overlapped = true);
293 /** Fetch the next token from the stream
294 * @return The next port number is returned, or 0 if none remain