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-2009 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) 2005-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/>.
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 * There are functors that accept std::string and
44 * compare/hash them as type irc::string by using
45 * mapping arrays internally.
46 *******************************************************/
48 /** Separate from the other casemap tables so that code *can* still exclusively rely on RFC casemapping
51 * This is provided as a pointer so that modules can change it to their custom mapping tables,
52 * e.g. for national character support.
54 CoreExport extern unsigned const char *national_case_insensitive_map;
56 /** A mapping of uppercase to lowercase, including scandinavian
57 * 'oddities' as specified by RFC1459, e.g. { -> [, and | -> \
59 CoreExport extern unsigned const char rfc_case_insensitive_map[256];
61 /** Case insensitive map, ASCII rules.
65 CoreExport extern unsigned const char ascii_case_insensitive_map[256];
67 /** The irc namespace contains a number of helper classes.
71 /** Check if two IRC object (e.g. nick or channel) names are equal.
72 * This function uses national_case_insensitive_map to determine equality, which, by default does comparison
73 * according to RFC 1459, treating certain otherwise non-identical characters as identical.
74 * @param s1 First string to compare
75 * @param s2 Second string to compare
76 * @return True if the two names are equal, false otherwise
78 CoreExport bool equals(const std::string& s1, const std::string& s2);
80 /** Check whether \p needle exists within \p haystack.
81 * @param haystack The string to search within.
82 * @param needle The string to search for.
83 * @return Either the index at which \p needle was found or std::string::npos.
85 CoreExport size_t find(const std::string& haystack, const std::string& needle);
87 /** This class returns true if two strings match.
88 * Case sensitivity is ignored, and the RFC 'character set'
93 /** The operator () does the actual comparison in hash_map
95 bool operator()(const std::string& s1, const std::string& s2) const
97 return equals(s1, s2);
103 size_t CoreExport operator()(const std::string &s) const;
106 struct insensitive_swo
108 bool CoreExport operator()(const std::string& a, const std::string& b) const;
111 /** irc::sepstream allows for splitting token separated lists.
112 * Each successive call to sepstream::GetToken() returns
113 * the next token, until none remain, at which point the method returns
116 class CoreExport sepstream
125 /** Current string position
128 /** If set then GetToken() can return an empty string
132 /** Create a sepstream and fill it with the provided data
134 sepstream(const std::string &source, char separator, bool allowempty = false);
136 /** Fetch the next token from the stream
137 * @param token The next token from the stream is placed here
138 * @return True if tokens still remain, false if there are none left
140 bool GetToken(std::string& token);
142 /** Fetch the next numeric 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 template<typename Numeric>
147 bool GetNumericToken(Numeric& token)
153 token = ConvToNum<Numeric>(str);
157 /** Fetch the entire remaining stream, without tokenizing
158 * @return The remaining part of the stream
160 const std::string GetRemaining();
162 /** Returns true if the end of the stream has been reached
163 * @return True if the end of the stream has been reached, otherwise false
167 /** Returns true if the specified value exists in the stream
168 * @param value The value to search for
169 * @return True if the value was found, False otherwise
171 bool Contains(const std::string& value);
174 /** A derived form of sepstream, which separates on commas
176 class CoreExport commasepstream : public sepstream
179 /** Initialize with comma separator
181 commasepstream(const std::string &source, bool allowempty = false) : sepstream(source, ',', allowempty)
186 /** A derived form of sepstream, which separates on spaces
188 class CoreExport spacesepstream : public sepstream
191 /** Initialize with space separator
193 spacesepstream(const std::string &source, bool allowempty = false) : sepstream(source, ' ', allowempty)
198 /** irc::tokenstream reads a string formatted as per RFC1459 and RFC2812.
199 * It will split the string into 'tokens' each containing one parameter
201 * For instance, if it is instantiated with the string:
202 * "PRIVMSG #test :foo bar baz qux"
203 * then each successive call to tokenstream::GetToken() will return
204 * "PRIVMSG", "#test", "foo bar baz qux", "".
205 * Note that if the whole string starts with a colon this is not taken
206 * to mean the string is all one parameter, and the first item in the
207 * list will be ":item". This is to allow for parsing 'source' fields
210 class CoreExport tokenstream
213 /** The message we are parsing tokens from. */
216 /** The current position within the message. */
220 /** Create a tokenstream and fill it with the provided data. */
221 tokenstream(const std::string& msg, size_t start = 0, size_t end = std::string::npos);
223 /** Retrieves the underlying message. */
224 std::string& GetMessage() { return message; }
226 /** Retrieve the next \<middle> token in the token stream.
227 * @param token The next token available, or an empty string if none remain.
228 * @return True if tokens are left to be read, false if the last token was just retrieved.
230 bool GetMiddle(std::string& token);
232 /** Retrieve the next \<trailing> 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 GetTrailing(std::string& token);
239 /** The portparser class separates out a port range into integers.
240 * A port range may be specified in the input string in the form
241 * "6660,6661,6662-6669,7020". The end of the stream is indicated by
242 * a return value of 0 from portparser::GetToken(). If you attempt
243 * to specify an illegal range (e.g. one where start >= end, or
244 * start or end < 0) then GetToken() will return the first element
245 * of the pair of numbers.
247 class CoreExport portparser
251 /** Used to split on commas
255 /** Current position in a range of ports
259 /** Starting port in a range of ports
263 /** Ending port in a range of ports
267 /** Allow overlapped port ranges
271 /** Used to determine overlapping of ports
272 * without O(n) algorithm being used
274 std::set<long> overlap_set;
276 /** Returns true if val overlaps an existing range
278 bool Overlaps(long val);
281 /** Create a portparser and fill it with the provided data
282 * @param source The source text to parse from
283 * @param allow_overlapped Allow overlapped ranges
285 portparser(const std::string &source, bool allow_overlapped = true);
287 /** Fetch the next token from the stream
288 * @return The next port number is returned, or 0 if none remain