summaryrefslogtreecommitdiff
path: root/libmailutils/string/cstrescape.c
blob: 120e562813843fbe15e9d98194c894c72184ed02 (plain)
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
/* GNU Mailutils -- a suite of utilities for electronic mail
   Copyright (C) 2016-2017 Free Software Foundation, Inc.

   GNU Mailutils 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, or (at your option)
   any later version.

   GNU Mailutils 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 GNU Mailutils.  If not, see <http://www.gnu.org/licenses/>. */

#include <config.h>
#include <stdlib.h>
#include <string.h>
#include <mailutils/cstr.h>
#include <mailutils/errno.h>

/* Examines STR for occurrences of characters from CHR.  Returns in RET_STR
   a malloc'ed string where each occurrence of CHR[i] is replaced by a
   backslash, followed by XTAB[i].

   If CHR is NULL, RET_STR contains a malloc'ed copy of STR (XTAB is
   ignored).

   If XTAB is NULL, XTAB = CHR is assumed.

   Callers are advised to include backslash into both CHR and XTAB.

   Returns 0 on success, error code if an error occurred.
   
   Example:

   Escape each occurrence of backslash and double quote:
   
     mu_c_str_escape (str, "\\\"", NULL, &ret_str)
*/
int
mu_c_str_escape (char const *str, char const *chr, char const *xtab,
		 char **ret_str)
{
  char *newstr;
  size_t n;
  int c;
  
  if (!ret_str)
    return MU_ERR_OUT_PTR_NULL;
  
  if (!str)
    {
      *ret_str = NULL;
      return 0;
    }

  if (!chr)
    {
      newstr = strdup (str);
      if (!newstr)
	return errno;
      *ret_str = newstr;
      return 0;
    }

  n = strlen (chr);

  if (xtab)
    {
      if (strlen (xtab) != n)
	return EINVAL;
    }
  else
    xtab = chr;
  
  n = mu_str_count (str, chr, NULL);
  
  newstr = malloc (strlen (str) + n + 1);
  if (!newstr)
    return errno;
  *ret_str = newstr;
  
  if (n == 0)
    {
      strcpy (newstr, str);
      return 0;
    }

  while ((c = *str++) != 0)
    {
      char *p = strchr (chr, c);

      if (p)
	{
	  *newstr++ = '\\';
          *newstr++ = xtab[p - chr];
	}
      else
	*newstr++ = c;
    }
  *newstr = 0;

  return 0;
}

/* Escape certain characters in STR.  Return allocated string in RET_STR.

   Escapable characters are defined by the array TRANS, which consists of an
   even number of elements.  Each pair of characters in this array contains:

     TRANS[i+1]  - character to be escaped
     TRANS[i]    - character to use in escape sequence for TRANS[i+1].

   Each TRANS[i+1] is replaced by backslash + TRANS[i].

   Returns 0 on success, or error code if an error occurred.

   E.g., to escape control characters, backslash and double-quote using
   C convention:

      mu_c_str_escape_trans (str, "\\\\\"\"a\ab\bf\fn\nr\rt\tv\v", &ret)

   See also mu_wordsplit_c_escape_tab in wordsplit.c
*/
int
mu_c_str_escape_trans (char const *str, char const *trans, char **ret_str)
{
  char *chr, *xtab;
  size_t n, i;
  int rc;
  
  if (trans)
    {
      n = strlen (trans);
      if (n % 2)
	return EINVAL;
      chr = malloc (n + 2);
      if (!chr)
	return errno;
      xtab = chr + n / 2 + 1;
      for (i = 0; i < n; i += 2)
	{
	  chr[i / 2] = trans[i + 1];
	  xtab[i / 2] = trans[i];
	}
      chr[i / 2] = xtab[i / 2] = 0;
    }
  else
    {
      chr = xtab = NULL;
    }

  rc = mu_c_str_escape (str, chr, xtab, ret_str);

  free (chr);

  return rc;
}
	
    

Return to:

Send suggestions and report system problems to the System administrator.