1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
|
/*
* Copyright (c) 2015, Vsevolod Stakhov
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY AUTHOR ''AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL AUTHOR BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef SRC_LIBUTIL_STR_UTIL_H_
#define SRC_LIBUTIL_STR_UTIL_H_
#include "config.h"
#include "ucl.h"
/**
* Compare two memory regions of size `l` using case insensitive matching
*/
gint rspamd_lc_cmp (const gchar *s, const gchar *d, gsize l);
/**
* Convert string to lowercase in-place using ASCII conversion
*/
void rspamd_str_lc (gchar *str, guint size);
/**
* Convert string to lowercase in-place using utf (limited) conversion
*/
void rspamd_str_lc_utf8 (gchar *str, guint size);
/*
* Hash table utility functions for case insensitive hashing
*/
guint rspamd_strcase_hash (gconstpointer key);
gboolean rspamd_strcase_equal (gconstpointer v, gconstpointer v2);
/*
* Hash table utility functions for case sensitive hashing
*/
guint rspamd_str_hash (gconstpointer key);
gboolean rspamd_str_equal (gconstpointer v, gconstpointer v2);
/*
* Hash table utility functions for hashing fixed strings
*/
guint rspamd_ftok_icase_hash (gconstpointer key);
gboolean rspamd_ftok_icase_equal (gconstpointer v, gconstpointer v2);
guint rspamd_gstring_icase_hash (gconstpointer key);
gboolean rspamd_gstring_icase_equal (gconstpointer v, gconstpointer v2);
/**
* Copy src to dest limited to len, in compare with standart strlcpy(3) rspamd strlcpy does not
* traverse the whole string and it is possible to use it for non NULL terminated strings. This is
* more like memccpy(dst, src, size, '\0')
*
* @param dst destination string
* @param src source string
* @param siz length of destination buffer
* @return bytes copied
*/
gsize rspamd_strlcpy (gchar *dst, const gchar *src, gsize siz);
/**
* Lowercase strlcpy variant
* @param dst
* @param src
* @param siz
* @return
*/
gsize rspamd_strlcpy_tolower (gchar *dst, const gchar *src, gsize siz);
/*
* Find string find in string s ignoring case
*/
gchar * rspamd_strncasestr (const gchar *s, const gchar *find, gint len);
/*
* Try to convert string of length to long
*/
gboolean rspamd_strtol (const gchar *s, gsize len, glong *value);
/*
* Try to convert string of length to unsigned long
*/
gboolean rspamd_strtoul (const gchar *s, gsize len, gulong *value);
/**
* Utility function to provide mem_pool copy for rspamd_hash_table_copy function
* @param data string to copy
* @param ud memory pool to use
* @return
*/
gpointer rspamd_str_pool_copy (gconstpointer data, gpointer ud);
/**
* Encode string using base32 encoding
* @param in input
* @param inlen input length
* @return freshly allocated base32 encoding of a specified string
*/
gchar * rspamd_encode_base32 (const guchar *in, gsize inlen);
/**
* Decode string using base32 encoding
* @param in input
* @param inlen input length
* @return freshly allocated base32 decoded value or NULL if input is invalid
*/
guchar* rspamd_decode_base32 (const gchar *in, gsize inlen, gsize *outlen);
/**
* Encode string using base64 encoding
* @param in input
* @param inlen input length
* @param str_len maximum string length (if <= 0 then no lines are split)
* @return freshly allocated base64 encoded value or NULL if input is invalid
*/
gchar * rspamd_encode_base64 (const guchar *in, gsize inlen, gint str_len,
gsize *outlen);
/**
* Encode and fold string using base64 encoding
* @param in input
* @param inlen input length
* @param str_len maximum string length (if <= 0 then no lines are split)
* @return freshly allocated base64 encoded value or NULL if input is invalid
*/
gchar * rspamd_encode_base64_fold (const guchar *in, gsize inlen, gint str_len,
gsize *outlen);
/**
* Decode URL encoded string in-place and return new length of a string, src and dst are NULL terminated
* @param dst
* @param src
* @param size
* @return
*/
gsize rspamd_decode_url (gchar *dst, const gchar *src, gsize size);
#ifndef g_tolower
# define g_tolower(x) (((x) >= 'A' && (x) <= 'Z') ? (x) - 'A' + 'a' : (x))
#endif
/**
* Return levenstein distance between two strings
* @param s1
* @param s1len
* @param s2
* @param s2len
* @return
*/
gint rspamd_strings_levenshtein_distance (const gchar *s1, gsize s1len,
const gchar *s2, gsize s2len);
/**
* Fold header using rfc822 rules, return new GString from the previous one
* @param name name of header (used just for folding)
* @param value value of header
* @return new GString with the folded value
*/
GString *rspamd_header_value_fold (const gchar *name,
const gchar *value,
guint fold_max);
/**
* Search for a substring `srch` in the text `in` using Karp-Rabin algorithm
* @param in input
* @param inlen input len
* @param srch search string
* @param srchlen length of the search string
* @return position of the first substring match or (-1) if not found
*/
goffset rspamd_substring_search (const gchar *in, gsize inlen,
const gchar *srch, gsize srchlen);
/**
* Search for end-of-headers mark in the input string. Returns position just after
* the last header in message (but before the last newline character).
* Hence, to obtain the real EOH position, it is also required to skip
* space characters
*/
goffset rspamd_string_find_eoh (GString *input);
/**
* Emit UCL object to gstring
* @param obj object to emit
* @param emit_type emitter type
* @param target target string
*/
void rspamd_ucl_emit_gstring (ucl_object_t *obj,
enum ucl_emitter emit_type,
GString *target);
/**
* Emit UCL object to fstring
* @param obj object to emit
* @param emit_type emitter type
* @param target target string
*/
void rspamd_ucl_emit_fstring (ucl_object_t *obj,
enum ucl_emitter emit_type,
rspamd_fstring_t **target);
#endif /* SRC_LIBUTIL_STR_UTIL_H_ */
|
