]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - include/hashcomp.h
Fix RPL_ADMINME not having the correct parameters.
[user/henk/code/inspircd.git] / include / hashcomp.h
1 /*
2  * InspIRCd -- Internet Relay Chat Daemon
3  *
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>
10  *
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.
14  *
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
18  * details.
19  *
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/>.
22  */
23
24
25 #pragma once
26
27 #include <cstring>
28 #include <string>
29 #include <vector>
30 #include <deque>
31 #include <map>
32 #include <set>
33 #include "inspircd.h"
34
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 \
41  * as identical to |.
42  *
43  * There are functors that accept std::string and
44  * compare/hash them as type irc::string by using
45  * mapping arrays internally.
46  *******************************************************/
47
48 /** Seperate from the other casemap tables so that code *can* still exclusively rely on RFC casemapping
49  * if it must.
50  *
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.
53  */
54 CoreExport extern unsigned const char *national_case_insensitive_map;
55
56 /** A mapping of uppercase to lowercase, including scandinavian
57  * 'oddities' as specified by RFC1459, e.g. { -> [, and | -> \
58  */
59 CoreExport extern unsigned const char rfc_case_insensitive_map[256];
60
61 /** Case insensitive map, ASCII rules.
62  * That is;
63  * [ != {, but A == a.
64  */
65 CoreExport extern unsigned const char ascii_case_insensitive_map[256];
66
67 /** The irc namespace contains a number of helper classes.
68  */
69 namespace irc
70 {
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
77          */
78         CoreExport bool equals(const std::string& s1, const std::string& s2);
79
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.
84          */
85         CoreExport size_t find(const std::string& haystack, const std::string& needle);
86
87         /** This class returns true if two strings match.
88          * Case sensitivity is ignored, and the RFC 'character set'
89          * is adhered to
90          */
91         struct StrHashComp
92         {
93                 /** The operator () does the actual comparison in hash_map
94                  */
95                 bool operator()(const std::string& s1, const std::string& s2) const
96                 {
97                         return equals(s1, s2);
98                 }
99         };
100
101         struct insensitive
102         {
103                 size_t CoreExport operator()(const std::string &s) const;
104         };
105
106         struct insensitive_swo
107         {
108                 bool CoreExport operator()(const std::string& a, const std::string& b) const;
109         };
110
111         /** irc::sepstream allows for splitting token seperated lists.
112          * Each successive call to sepstream::GetToken() returns
113          * the next token, until none remain, at which point the method returns
114          * false.
115          */
116         class CoreExport sepstream
117         {
118          protected:
119                 /** Original string.
120                  */
121                 std::string tokens;
122                 /** Separator value
123                  */
124                 char sep;
125                 /** Current string position
126                  */
127                 size_t pos;
128                 /** If set then GetToken() can return an empty string
129                  */
130                 bool allow_empty;
131          public:
132                 /** Create a sepstream and fill it with the provided data
133                  */
134                 sepstream(const std::string &source, char separator, bool allowempty = false);
135
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
139                  */
140                 bool GetToken(std::string& token);
141
142                 /** Fetch the entire remaining stream, without tokenizing
143                  * @return The remaining part of the stream
144                  */
145                 const std::string GetRemaining();
146
147                 /** Returns true if the end of the stream has been reached
148                  * @return True if the end of the stream has been reached, otherwise false
149                  */
150                 bool StreamEnd();
151         };
152
153         /** A derived form of sepstream, which seperates on commas
154          */
155         class CoreExport commasepstream : public sepstream
156         {
157          public:
158                 /** Initialize with comma separator
159                  */
160                 commasepstream(const std::string &source, bool allowempty = false) : sepstream(source, ',', allowempty)
161                 {
162                 }
163         };
164
165         /** A derived form of sepstream, which seperates on spaces
166          */
167         class CoreExport spacesepstream : public sepstream
168         {
169          public:
170                 /** Initialize with space separator
171                  */
172                 spacesepstream(const std::string &source, bool allowempty = false) : sepstream(source, ' ', allowempty)
173                 {
174                 }
175         };
176
177         /** irc::tokenstream reads a string formatted as per RFC1459 and RFC2812.
178          * It will split the string into 'tokens' each containing one parameter
179          * from the string.
180          * For instance, if it is instantiated with the string:
181          * "PRIVMSG #test :foo bar baz qux"
182          * then each successive call to tokenstream::GetToken() will return
183          * "PRIVMSG", "#test", "foo bar baz qux", "".
184          * Note that if the whole string starts with a colon this is not taken
185          * to mean the string is all one parameter, and the first item in the
186          * list will be ":item". This is to allow for parsing 'source' fields
187          * from data.
188          */
189         class CoreExport tokenstream
190         {
191         private:
192                 /** The message we are parsing tokens from. */
193                 std::string message;
194
195                 /** The current position within the message. */
196                 size_t position;
197
198          public:
199                 /** Create a tokenstream and fill it with the provided data. */
200                 tokenstream(const std::string& msg, size_t start = 0, size_t end = std::string::npos);
201
202                 /** Retrieves the underlying message. */
203                 std::string& GetMessage() { return message; }
204
205                 /** Retrieve the next \<middle> token in the token stream.
206                  * @param token The next token available, or an empty string if none remain.
207                  * @return True if tokens are left to be read, false if the last token was just retrieved.
208                  */
209                 bool GetMiddle(std::string& token);
210
211                 /** Retrieve the next \<trailing> token in the token stream.
212                  * @param token The next token available, or an empty string if none remain.
213                  * @return True if tokens are left to be read, false if the last token was just retrieved.
214                  */
215                 bool GetTrailing(std::string& token);
216         };
217
218         /** The portparser class seperates out a port range into integers.
219          * A port range may be specified in the input string in the form
220          * "6660,6661,6662-6669,7020". The end of the stream is indicated by
221          * a return value of 0 from portparser::GetToken(). If you attempt
222          * to specify an illegal range (e.g. one where start >= end, or
223          * start or end < 0) then GetToken() will return the first element
224          * of the pair of numbers.
225          */
226         class CoreExport portparser
227         {
228          private:
229
230                 /** Used to split on commas
231                  */
232                 commasepstream sep;
233
234                 /** Current position in a range of ports
235                  */
236                 long in_range;
237
238                 /** Starting port in a range of ports
239                  */
240                 long range_begin;
241
242                 /** Ending port in a range of ports
243                  */
244                 long range_end;
245
246                 /** Allow overlapped port ranges
247                  */
248                 bool overlapped;
249
250                 /** Used to determine overlapping of ports
251                  * without O(n) algorithm being used
252                  */
253                 std::set<long> overlap_set;
254
255                 /** Returns true if val overlaps an existing range
256                  */
257                 bool Overlaps(long val);
258          public:
259
260                 /** Create a portparser and fill it with the provided data
261                  * @param source The source text to parse from
262                  * @param allow_overlapped Allow overlapped ranges
263                  */
264                 portparser(const std::string &source, bool allow_overlapped = true);
265
266                 /** Fetch the next token from the stream
267                  * @return The next port number is returned, or 0 if none remain
268                  */
269                 long GetToken();
270         };
271 }