DevOrSysAdminScripts/string_escaping.libr.php at main · LLyaudet/DevOrSysAdminScripts · GitHub

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
<?php
/*
This file is part of DevOrSysAdminScripts library.

DevOrSysAdminScripts is free software:
you can redistribute it and/or modify it under the terms
of the GNU Lesser General Public License
as published by the Free Software Foundation,
either version 3 of the License,
or (at your option) any later version.

DevOrSysAdminScripts 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 Lesser General Public License for more details.

You should have received a copy of
the GNU Lesser General Public License
along with DevOrSysAdminScripts.
If not, see <https://www.gnu.org/licenses/>.

©Copyright 2023-2026 Laurent Frédéric Bernard François Lyaudet
*/

namespace string_escaping\HTML {
  function escape_text($s_string){
    return str_replace(
      array(
        '&',
        '<',
      ),
      array(
        '&amp;',
        '&lt;',
      ),
      $s_string,
    );
  }


  function escape_attribute($s_string){
    # in double quotes
    return str_replace(
      array('"'),
      array('&quot;'),
      $s_string,
    );
  }


  function escape_pre($s_string){
    return str_replace(
      array(
        '&',
        '<',
      ),
      array(
        '&amp;',
        '&lt;',
      ),
      $s_string,
    );
  }
}


namespace string_escaping\XHTML {
  function escape_text($s_string){
    return str_replace(
      array(
        '&',
        '<',
      ),
      array(
        '&amp;',
        '&lt;',
      ),
      $s_string,
    );
  }


  function escape_attribute($s_string){
    # in double quotes
    return str_replace(
      array(
        '&',
        '<',
        '"',
        "\n",
      ),
      array(
        '&amp;',
        '&lt;',
        '&quot;',
        '&#10;'
      ),
      $s_string,
    );
  }


  function escape_pre($s_string){
    return str_replace(
      array(
        '&',
        '<',
      ),
      array(
        '&amp;',
        '&lt;',
      ),
      $s_string,
    );
  }
}


namespace string_escaping\JS {
  use function string_escaping\XHTML\escape_text as XHTML_escape_text;

  function escape($s_string){
    return str_replace(
      array(
        '\\',
        "\n",
        "'",
        '"',
      ),
      array(
        '\\\\',
        '\n',
        '\\\'',
        '\\"',
      ),
      $s_string,
    );
  }


  function escape_for_string_definition_inside_XHTML($s_string){
    return XHTML_escape_text(escape($s_string));
  }
}

/*
$ php
<?php
require_once('string_escaping.libr.php');
var_dump(string_escaping\HTML\escape_text('<&"\'truc\\'));
var_dump(string_escaping\HTML\escape_attribute("<&\"\n'truc\\"));
var_dump(string_escaping\HTML\escape_pre("<&\"\n'truc\\"));
var_dump(string_escaping\XHTML\escape_text('<&"\'truc\\'));
var_dump(string_escaping\XHTML\escape_attribute("<&\"\n'truc\\"));
var_dump(string_escaping\XHTML\escape_pre("<&\"\n'truc\\"));
var_dump(string_escaping\JS\escape("abcd & < > \\ \n  \"'"));
var_dump(string_escaping\JS\escape_for_string_definition_inside_XHTML(
  "abcd & < > \\ \n  \"'"
));
*/