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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
|
/*
Functions for escaping and unescaping strings
Copyright (C) 2009-2023
Free Software Foundation, Inc.
Written by:
Slava Zanko <slavazanko@gmail.com>, 2009;
Patrick Winnertz <winnie@debian.org>, 2009
This file is part of the Midnight Commander.
The Midnight Commander is free software: you can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the License,
or (at your option) any later version.
The Midnight Commander is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include <config.h>
#include "lib/global.h"
#include "lib/strescape.h"
/*** global variables ****************************************************************************/
/*** file scope macro definitions ****************************************************************/
/*** file scope type declarations ****************************************************************/
/*** forward declarations (file scope functions) *************************************************/
/*** file scope variables ************************************************************************/
static const char ESCAPE_SHELL_CHARS[] = " !#$%()&{}[]`?|<>;*\\\"'";
static const char ESCAPE_REGEX_CHARS[] = "^!#$%()&{}[]`?|<>;*+.\\";
static const char ESCAPE_GLOB_CHARS[] = "$*\\?";
/* --------------------------------------------------------------------------------------------- */
/*** file scope functions ************************************************************************/
/* --------------------------------------------------------------------------------------------- */
/* --------------------------------------------------------------------------------------------- */
/*** public functions ****************************************************************************/
/* --------------------------------------------------------------------------------------------- */
char *
strutils_escape (const char *src, gsize src_len, const char *escaped_chars,
gboolean escape_non_printable)
{
GString *ret;
gsize curr_index;
/* do NOT break allocation semantics */
if (src == NULL)
return NULL;
if (*src == '\0')
return strdup ("");
ret = g_string_new ("");
if (src_len == (gsize) (-1))
src_len = strlen (src);
for (curr_index = 0; curr_index < src_len; curr_index++)
{
if (escape_non_printable)
{
switch (src[curr_index])
{
case '\n':
g_string_append (ret, "\\n");
continue;
case '\t':
g_string_append (ret, "\\t");
continue;
case '\b':
g_string_append (ret, "\\b");
continue;
case '\0':
g_string_append (ret, "\\0");
continue;
default:
break;
}
}
if (strchr (escaped_chars, (int) src[curr_index]))
g_string_append_c (ret, '\\');
g_string_append_c (ret, src[curr_index]);
}
return g_string_free (ret, FALSE);
}
/* --------------------------------------------------------------------------------------------- */
char *
strutils_unescape (const char *src, gsize src_len, const char *unescaped_chars,
gboolean unescape_non_printable)
{
GString *ret;
gsize curr_index;
if (src == NULL)
return NULL;
if (*src == '\0')
return strdup ("");
ret = g_string_sized_new (16);
if (src_len == (gsize) (-1))
src_len = strlen (src);
src_len--;
for (curr_index = 0; curr_index < src_len; curr_index++)
{
if (src[curr_index] != '\\')
{
g_string_append_c (ret, src[curr_index]);
continue;
}
curr_index++;
if (unescaped_chars == ESCAPE_SHELL_CHARS && src[curr_index] == '$')
{
/* special case: \$ is used to disallow variable substitution */
g_string_append_c (ret, '\\');
}
else
{
if (unescape_non_printable)
{
switch (src[curr_index])
{
case 'n':
g_string_append_c (ret, '\n');
continue;
case 't':
g_string_append_c (ret, '\t');
continue;
case 'b':
g_string_append_c (ret, '\b');
continue;
case '0':
g_string_append_c (ret, '\0');
continue;
default:
break;
}
}
if (strchr (unescaped_chars, (int) src[curr_index]) == NULL)
g_string_append_c (ret, '\\');
}
g_string_append_c (ret, src[curr_index]);
}
g_string_append_c (ret, src[curr_index]);
return g_string_free (ret, FALSE);
}
/* --------------------------------------------------------------------------------------------- */
/**
* To be compatible with the general posix command lines we have to escape
* strings for the command line
*
* @param src string for escaping
*
* @return escaped string (which needs to be freed later) or NULL when NULL string is passed.
*/
char *
strutils_shell_escape (const char *src)
{
return strutils_escape (src, -1, ESCAPE_SHELL_CHARS, FALSE);
}
/* --------------------------------------------------------------------------------------------- */
char *
strutils_glob_escape (const char *src)
{
return strutils_escape (src, -1, ESCAPE_GLOB_CHARS, TRUE);
}
/* --------------------------------------------------------------------------------------------- */
char *
strutils_regex_escape (const char *src)
{
return strutils_escape (src, -1, ESCAPE_REGEX_CHARS, TRUE);
}
/* --------------------------------------------------------------------------------------------- */
/**
* Unescape paths or other strings for e.g the internal cd
* shell-unescape within a given buffer (writing to it!)
*
* @param text string for unescaping
*
* @return unescaped string (which needs to be freed)
*/
char *
strutils_shell_unescape (const char *text)
{
return strutils_unescape (text, -1, ESCAPE_SHELL_CHARS, TRUE);
}
/* --------------------------------------------------------------------------------------------- */
char *
strutils_glob_unescape (const char *text)
{
return strutils_unescape (text, -1, ESCAPE_GLOB_CHARS, TRUE);
}
/* --------------------------------------------------------------------------------------------- */
char *
strutils_regex_unescape (const char *text)
{
return strutils_unescape (text, -1, ESCAPE_REGEX_CHARS, TRUE);
}
/* --------------------------------------------------------------------------------------------- */
/**
* Check if char in pointer contain escape'd chars
*
* @param start string for checking
* @param current pointer to checked character
*
* @return TRUE if string contain escaped chars otherwise return FALSE
*/
gboolean
strutils_is_char_escaped (const char *start, const char *current)
{
int num_esc = 0;
if (start == NULL || current == NULL || current <= start)
return FALSE;
current--;
while (current >= start && *current == '\\')
{
num_esc++;
current--;
}
return (gboolean) num_esc % 2;
}
/* --------------------------------------------------------------------------------------------- */
|
