|
0
|
1 /* |
|
|
2 * util.h -- some utilities |
|
|
3 * |
|
|
4 * Copyright (c) 2013-2016 David Demelier <markand@malikania.fr> |
|
|
5 * |
|
|
6 * Permission to use, copy, modify, and/or distribute this software for any |
|
|
7 * purpose with or without fee is hereby granted, provided that the above |
|
|
8 * copyright notice and this permission notice appear in all copies. |
|
|
9 * |
|
|
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
|
|
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
|
|
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
|
|
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
|
|
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
|
|
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
|
|
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
|
|
17 */ |
|
|
18 |
|
|
19 #ifndef _IRCCD_UTIL_H_ |
|
|
20 #define _IRCCD_UTIL_H_ |
|
|
21 |
|
|
22 #include <ctime> |
|
|
23 #include <initializer_list> |
|
|
24 #include <regex> |
|
|
25 #include <sstream> |
|
|
26 #include <string> |
|
|
27 #include <unordered_map> |
|
|
28 #include <vector> |
|
|
29 |
|
|
30 namespace irccd { |
|
|
31 |
|
|
32 namespace util { |
|
|
33 |
|
|
34 /** |
|
|
35 * @enum MessageType |
|
|
36 * @brief Describe which type of message has been received |
|
|
37 * |
|
|
38 * On channels and queries, you may have a special command or a standard message depending on the |
|
|
39 * beginning of the message. |
|
|
40 * |
|
|
41 * Example: `!reminder help' may invoke the command event if a plugin reminder exists. |
|
|
42 */ |
|
|
43 enum class MessageType { |
|
|
44 Command, //!< special command |
|
|
45 Message //!< standard message |
|
|
46 }; |
|
|
47 |
|
|
48 /** |
|
|
49 * @brief Combine the type of message and its content. |
|
|
50 */ |
|
|
51 using MessagePair = std::pair<std::string, MessageType>; |
|
|
52 |
|
|
53 /** |
|
|
54 * @class Substitution |
|
|
55 * @brief Used for format() function. |
|
|
56 */ |
|
|
57 class Substitution { |
|
|
58 public: |
|
|
59 /** |
|
|
60 * Fill that field if you want a date. |
|
|
61 */ |
|
|
62 std::time_t time{std::time(nullptr)}; |
|
|
63 |
|
|
64 /** |
|
|
65 * Fill that map if you want to replace keywords. |
|
|
66 */ |
|
|
67 std::unordered_map<std::string, std::string> keywords; |
|
|
68 }; |
|
|
69 |
|
|
70 /** |
|
|
71 * Format a string and update all templates. |
|
|
72 * |
|
|
73 * Syntax |
|
|
74 * ====== |
|
|
75 * |
|
|
76 * The syntax is ?{} where ? is replaced by one of the token defined below. Braces are mandatory and cannot be ommited. |
|
|
77 * To write a literal template construct, prepend the token twice. |
|
|
78 * |
|
|
79 * Availables templates |
|
|
80 * ==================== |
|
|
81 * |
|
|
82 * The following templates are available: |
|
|
83 * |
|
|
84 * - #{name}, name will be substituted from the keywords in params |
|
|
85 * - ${name}, name will be substituted from the environment variable |
|
|
86 * - @{attributes}, the attributes will be substituted to IRC colors (see below) |
|
|
87 * - %, any format accepted by strftime(3) |
|
|
88 * |
|
|
89 * Attributes |
|
|
90 * ========== |
|
|
91 * |
|
|
92 * The attribute format is composed of three parts, foreground, background and modifiers, each separated by a comma. |
|
|
93 * |
|
|
94 * **Note:** you cannot omit parameters, to specify the background, you must specify the foreground. |
|
|
95 * |
|
|
96 * Examples |
|
|
97 * ======== |
|
|
98 * |
|
|
99 * Valid constructs |
|
|
100 * ---------------- |
|
|
101 * |
|
|
102 * - `#{target}, welcome`: if target is set to "irccd", becomes "irccd, welcome", |
|
|
103 * - `@{red}#{target}`: if target is specified, it is written in red, |
|
|
104 * |
|
|
105 * Invalid or literals constructs |
|
|
106 * ------------------------------ |
|
|
107 * |
|
|
108 * - `##{target}`: will output "#{target}", |
|
|
109 * - `##`: will output "##", |
|
|
110 * - `#target`: will output "#target", |
|
|
111 * - `#{target`: will throw std::invalid_argument. |
|
|
112 * |
|
|
113 * Colors & attributes |
|
|
114 * ------------------- |
|
|
115 * |
|
|
116 * - `@{red,blue}`: will write text red on blue background, |
|
|
117 * - `@{default,yellow}`: will write default color text on yellow background |
|
|
118 * - `@{white,black,bold,underline}`: will write white text on black in both bold and underline |
|
|
119 */ |
|
|
120 std::string format(std::string text, const Substitution ¶ms = {}); |
|
|
121 |
|
|
122 /** |
|
|
123 * Remove leading and trailing spaces. |
|
|
124 * |
|
|
125 * @param str the string |
|
|
126 * @return the removed white spaces |
|
|
127 */ |
|
|
128 std::string strip(std::string str); |
|
|
129 |
|
|
130 /** |
|
|
131 * Split a string by delimiters. |
|
|
132 * |
|
|
133 * @param list the string to split |
|
|
134 * @param delimiter a list of delimiters |
|
|
135 * @param max max number of split |
|
|
136 * @return a list of string splitted |
|
|
137 */ |
|
|
138 std::vector<std::string> split(const std::string &list, const std::string &delimiters, int max = -1); |
|
|
139 |
|
|
140 /** |
|
|
141 * Join values by a separator and return a string. |
|
|
142 * |
|
|
143 * @param first the first iterator |
|
|
144 * @param last the last iterator |
|
|
145 * @param delim the optional delimiter |
|
|
146 */ |
|
|
147 template <typename InputIt, typename DelimType = char> |
|
|
148 std::string join(InputIt first, InputIt last, DelimType delim = ':') |
|
|
149 { |
|
|
150 std::ostringstream oss; |
|
|
151 |
|
|
152 if (first != last) { |
|
|
153 oss << *first; |
|
|
154 |
|
|
155 while (++first != last) |
|
|
156 oss << delim << *first; |
|
|
157 } |
|
|
158 |
|
|
159 return oss.str(); |
|
|
160 } |
|
|
161 |
|
|
162 /** |
|
|
163 * Convenient overload. |
|
|
164 * |
|
|
165 * @param list the initializer list |
|
|
166 * @param delim the delimiter |
|
|
167 * @return the string |
|
|
168 */ |
|
|
169 template <typename T, typename DelimType = char> |
|
|
170 inline std::string join(std::initializer_list<T> list, DelimType delim = ':') |
|
|
171 { |
|
|
172 return join(list.begin(), list.end(), delim); |
|
|
173 } |
|
|
174 |
|
|
175 /** |
|
|
176 * Parse IRC message and determine if it's a command or a simple message. |
|
|
177 * |
|
|
178 * @param message the message line |
|
|
179 * @param commandChar the command char (e.g '!') |
|
|
180 * @param plugin the plugin name |
|
|
181 * @return the pair |
|
|
182 */ |
|
|
183 MessagePair parseMessage(std::string message, const std::string &commandChar, const std::string &plugin); |
|
|
184 |
|
|
185 /** |
|
|
186 * Server and identities must have strict names. This function can |
|
|
187 * be used to ensure that they are valid. |
|
|
188 * |
|
|
189 * @param name the identifier name |
|
|
190 * @return true if is valid |
|
|
191 */ |
|
|
192 inline bool isIdentifierValid(const std::string &name) |
|
|
193 { |
|
|
194 return std::regex_match(name, std::regex("[A-Za-z0-9-_]+")); |
|
|
195 } |
|
|
196 |
|
|
197 /** |
|
|
198 * Check if the value is a boolean, 1, yes and true are accepted. |
|
|
199 * |
|
|
200 * @param value the value |
|
|
201 * @return true if is boolean |
|
|
202 * @note this function is case-insensitive |
|
|
203 */ |
|
|
204 bool isBoolean(std::string value) noexcept; |
|
|
205 |
|
|
206 /** |
|
|
207 * Check if the string is an integer. |
|
|
208 * |
|
|
209 * @param value the input |
|
|
210 * @param base the optional base |
|
|
211 * @return true if integer |
|
|
212 */ |
|
|
213 bool isInt(const std::string &value, int base = 10) noexcept; |
|
|
214 |
|
|
215 /** |
|
|
216 * Check if the string is real. |
|
|
217 * |
|
|
218 * @param value the value |
|
|
219 * @return true if real |
|
|
220 */ |
|
|
221 bool isReal(const std::string &value) noexcept; |
|
|
222 |
|
|
223 /** |
|
|
224 * Check if the string is a number. |
|
|
225 * |
|
|
226 * @param value the value |
|
|
227 * @return true if it is a number |
|
|
228 */ |
|
|
229 inline bool isNumber(const std::string &value) noexcept |
|
|
230 { |
|
|
231 return isInt(value) || isReal(value); |
|
|
232 } |
|
|
233 |
|
|
234 /** |
|
|
235 * Parse a network message from an input buffer and remove it from it. |
|
|
236 * |
|
|
237 * @param input the buffer, will be updated |
|
|
238 * @return the message or empty string if there is nothing |
|
|
239 */ |
|
|
240 std::string nextNetwork(std::string &input); |
|
|
241 |
|
|
242 } // !util |
|
|
243 |
|
|
244 } // !irccd |
|
|
245 |
|
|
246 #endif // !_IRCCD_UTIL_H_ |
