|
1
|
<?php
|
|
2
|
|
|
3
|
/**
|
|
4
|
* @file
|
|
5
|
* Helper class to clean strings to make them URL safe and translatable.
|
|
6
|
*
|
|
7
|
* This was copied directly from pathauto and put here to be made available
|
|
8
|
* to all, because more things than just pathauto want URL safe strings.
|
|
9
|
*
|
|
10
|
* To use, simply:
|
|
11
|
* @code
|
|
12
|
* ctools_include('cleanstring');
|
|
13
|
* $output = ctools_cleanstring($string);
|
|
14
|
*
|
|
15
|
* You can add a variety of settings as an array in the second argument,
|
|
16
|
* including words to ignore, how to deal with punctuation, length
|
|
17
|
* limits, and more. See the function itself for options.
|
|
18
|
*/
|
|
19
|
|
|
20
|
/**
|
|
21
|
* Matches Unicode character classes.
|
|
22
|
*
|
|
23
|
* See: http://www.unicode.org/Public/UNIDATA/UCD.html#General_Category_Values.
|
|
24
|
*
|
|
25
|
* The index only contains the following character classes:
|
|
26
|
* Lu Letter, Uppercase
|
|
27
|
* Ll Letter, Lowercase
|
|
28
|
* Lt Letter, Titlecase
|
|
29
|
* Lo Letter, Other
|
|
30
|
* Nd Number, Decimal Digit
|
|
31
|
* No Number, Other
|
|
32
|
*
|
|
33
|
* Copied from search.module's PREG_CLASS_SEARCH_EXCLUDE.
|
|
34
|
*/
|
|
35
|
define('CTOOLS_PREG_CLASS_ALNUM',
|
|
36
|
'\x{0}-\x{2f}\x{3a}-\x{40}\x{5b}-\x{60}\x{7b}-\x{bf}\x{d7}\x{f7}\x{2b0}-' .
|
|
37
|
'\x{385}\x{387}\x{3f6}\x{482}-\x{489}\x{559}-\x{55f}\x{589}-\x{5c7}\x{5f3}-' .
|
|
38
|
'\x{61f}\x{640}\x{64b}-\x{65e}\x{66a}-\x{66d}\x{670}\x{6d4}\x{6d6}-\x{6ed}' .
|
|
39
|
'\x{6fd}\x{6fe}\x{700}-\x{70f}\x{711}\x{730}-\x{74a}\x{7a6}-\x{7b0}\x{901}-' .
|
|
40
|
'\x{903}\x{93c}\x{93e}-\x{94d}\x{951}-\x{954}\x{962}-\x{965}\x{970}\x{981}-' .
|
|
41
|
'\x{983}\x{9bc}\x{9be}-\x{9cd}\x{9d7}\x{9e2}\x{9e3}\x{9f2}-\x{a03}\x{a3c}-' .
|
|
42
|
'\x{a4d}\x{a70}\x{a71}\x{a81}-\x{a83}\x{abc}\x{abe}-\x{acd}\x{ae2}\x{ae3}' .
|
|
43
|
'\x{af1}-\x{b03}\x{b3c}\x{b3e}-\x{b57}\x{b70}\x{b82}\x{bbe}-\x{bd7}\x{bf0}-' .
|
|
44
|
'\x{c03}\x{c3e}-\x{c56}\x{c82}\x{c83}\x{cbc}\x{cbe}-\x{cd6}\x{d02}\x{d03}' .
|
|
45
|
'\x{d3e}-\x{d57}\x{d82}\x{d83}\x{dca}-\x{df4}\x{e31}\x{e34}-\x{e3f}\x{e46}-' .
|
|
46
|
'\x{e4f}\x{e5a}\x{e5b}\x{eb1}\x{eb4}-\x{ebc}\x{ec6}-\x{ecd}\x{f01}-\x{f1f}' .
|
|
47
|
'\x{f2a}-\x{f3f}\x{f71}-\x{f87}\x{f90}-\x{fd1}\x{102c}-\x{1039}\x{104a}-' .
|
|
48
|
'\x{104f}\x{1056}-\x{1059}\x{10fb}\x{10fc}\x{135f}-\x{137c}\x{1390}-\x{1399}' .
|
|
49
|
'\x{166d}\x{166e}\x{1680}\x{169b}\x{169c}\x{16eb}-\x{16f0}\x{1712}-\x{1714}' .
|
|
50
|
'\x{1732}-\x{1736}\x{1752}\x{1753}\x{1772}\x{1773}\x{17b4}-\x{17db}\x{17dd}' .
|
|
51
|
'\x{17f0}-\x{180e}\x{1843}\x{18a9}\x{1920}-\x{1945}\x{19b0}-\x{19c0}\x{19c8}' .
|
|
52
|
'\x{19c9}\x{19de}-\x{19ff}\x{1a17}-\x{1a1f}\x{1d2c}-\x{1d61}\x{1d78}\x{1d9b}-' .
|
|
53
|
'\x{1dc3}\x{1fbd}\x{1fbf}-\x{1fc1}\x{1fcd}-\x{1fcf}\x{1fdd}-\x{1fdf}\x{1fed}-' .
|
|
54
|
'\x{1fef}\x{1ffd}-\x{2070}\x{2074}-\x{207e}\x{2080}-\x{2101}\x{2103}-\x{2106}' .
|
|
55
|
'\x{2108}\x{2109}\x{2114}\x{2116}-\x{2118}\x{211e}-\x{2123}\x{2125}\x{2127}' .
|
|
56
|
'\x{2129}\x{212e}\x{2132}\x{213a}\x{213b}\x{2140}-\x{2144}\x{214a}-\x{2b13}' .
|
|
57
|
'\x{2ce5}-\x{2cff}\x{2d6f}\x{2e00}-\x{3005}\x{3007}-\x{303b}\x{303d}-\x{303f}' .
|
|
58
|
'\x{3099}-\x{309e}\x{30a0}\x{30fb}-\x{30fe}\x{3190}-\x{319f}\x{31c0}-\x{31cf}' .
|
|
59
|
'\x{3200}-\x{33ff}\x{4dc0}-\x{4dff}\x{a015}\x{a490}-\x{a716}\x{a802}\x{a806}' .
|
|
60
|
'\x{a80b}\x{a823}-\x{a82b}\x{e000}-\x{f8ff}\x{fb1e}\x{fb29}\x{fd3e}\x{fd3f}' .
|
|
61
|
'\x{fdfc}-\x{fe6b}\x{feff}-\x{ff0f}\x{ff1a}-\x{ff20}\x{ff3b}-\x{ff40}\x{ff5b}-' .
|
|
62
|
'\x{ff65}\x{ff70}\x{ff9e}\x{ff9f}\x{ffe0}-\x{fffd}');
|
|
63
|
|
|
64
|
/**
|
|
65
|
* Clean up a string value provided by a module.
|
|
66
|
*
|
|
67
|
* Resulting string contains only alphanumerics and separators.
|
|
68
|
*
|
|
69
|
* @param $string
|
|
70
|
* A string to clean.
|
|
71
|
* @param $settings
|
|
72
|
* An optional array of settings to use.
|
|
73
|
* - 'clean slash': If set, slashes will be cleaned. Defaults to TRUE,
|
|
74
|
* so you have to explicitly set this to FALSE to not clean the
|
|
75
|
* slashes.
|
|
76
|
* - 'ignore words': Set to an array of words that will be removed
|
|
77
|
* rather than made safe. Defaults to an empty array.
|
|
78
|
* - 'separator': Change spaces and untranslatable characters to
|
|
79
|
* this character. Defaults to '-' .
|
|
80
|
* - 'replacements': An array of direct replacements to be made that will
|
|
81
|
* be implemented via strtr(). Defaults to an empty array.
|
|
82
|
* - 'transliterate': If set, use the transliteration replacements. If set
|
|
83
|
* to an array, use these replacements instead of the defaults in CTools.
|
|
84
|
* Defaults to FALSE.
|
|
85
|
* - 'reduce ascii': If set to TRUE further reduce to ASCII96 only. Defaults
|
|
86
|
* to TRUE.
|
|
87
|
* - 'max length': If set to a number, reduce the resulting string to this
|
|
88
|
* maximum length. Defaults to no maximum length.
|
|
89
|
* - 'lower case': If set to TRUE, convert the result to lower case.
|
|
90
|
* Defaults to false.
|
|
91
|
* These settings will be passed through drupal_alter.
|
|
92
|
*
|
|
93
|
* @return
|
|
94
|
* The cleaned string.
|
|
95
|
*/
|
|
96
|
function ctools_cleanstring($string, $settings = array()) {
|
|
97
|
$settings += array(
|
|
98
|
'clean slash' => TRUE,
|
|
99
|
'ignore words' => array(),
|
|
100
|
'separator' => '-',
|
|
101
|
'replacements' => array(),
|
|
102
|
'transliterate' => FALSE,
|
|
103
|
'reduce ascii' => TRUE,
|
|
104
|
'max length' => FALSE,
|
|
105
|
'lower case' => FALSE,
|
|
106
|
);
|
|
107
|
|
|
108
|
// Allow modules to make other changes to the settings.
|
|
109
|
if (isset($settings['clean id'])) {
|
|
110
|
drupal_alter('ctools_cleanstring_' . $settings['clean id'], $settings);
|
|
111
|
}
|
|
112
|
|
|
113
|
drupal_alter('ctools_cleanstring', $settings);
|
|
114
|
|
|
115
|
$output = $string;
|
|
116
|
|
|
117
|
// Do any replacements the user selected up front.
|
|
118
|
if (!empty($settings['replacements'])) {
|
|
119
|
$output = strtr($output, $settings['replacements']);
|
|
120
|
}
|
|
121
|
|
|
122
|
// Remove slashes if instructed to do so.
|
|
123
|
if ($settings['clean slash']) {
|
|
124
|
$output = str_replace('/', '', $output);
|
|
125
|
}
|
|
126
|
|
|
127
|
if (!empty($settings['transliterate']) && module_exists('transliteration')) {
|
|
128
|
$output = transliteration_get($output);
|
|
129
|
}
|
|
130
|
|
|
131
|
// Reduce to the subset of ASCII96 letters and numbers.
|
|
132
|
if ($settings['reduce ascii']) {
|
|
133
|
$pattern = '/[^a-zA-Z0-9\/]+/';
|
|
134
|
$output = preg_replace($pattern, $settings['separator'], $output);
|
|
135
|
}
|
|
136
|
|
|
137
|
// Get rid of words that are on the ignore list.
|
|
138
|
if (!empty($settings['ignore words'])) {
|
|
139
|
$ignore_re = '\b' . preg_replace('/,/', '\b|\b', $settings['ignore words']) . '\b';
|
|
140
|
|
|
141
|
if (function_exists('mb_eregi_replace')) {
|
|
142
|
$output = mb_eregi_replace($ignore_re, '', $output);
|
|
143
|
}
|
|
144
|
else {
|
|
145
|
$output = preg_replace("/$ignore_re/i", '', $output);
|
|
146
|
}
|
|
147
|
}
|
|
148
|
|
|
149
|
// Always replace whitespace with the separator.
|
|
150
|
$output = preg_replace('/\s+/', $settings['separator'], $output);
|
|
151
|
|
|
152
|
// In preparation for pattern matching,
|
|
153
|
// escape the separator if and only if it is not alphanumeric.
|
|
154
|
if (isset($settings['separator'])) {
|
|
155
|
if (preg_match('/^[^' . CTOOLS_PREG_CLASS_ALNUM . ']+$/uD', $settings['separator'])) {
|
|
156
|
$seppattern = $settings['separator'];
|
|
157
|
}
|
|
158
|
else {
|
|
159
|
$seppattern = '\\' . $settings['separator'];
|
|
160
|
}
|
|
161
|
// Trim any leading or trailing separators (note the need to.
|
|
162
|
$output = preg_replace("/^$seppattern+|$seppattern+$/", '', $output);
|
|
163
|
|
|
164
|
// Replace multiple separators with a single one.
|
|
165
|
$output = preg_replace("/$seppattern+/", $settings['separator'], $output);
|
|
166
|
}
|
|
167
|
|
|
168
|
// Enforce the maximum component length.
|
|
169
|
if (!empty($settings['max length'])) {
|
|
170
|
$output = ctools_cleanstring_truncate($output, $settings['max length'], $settings['separator']);
|
|
171
|
}
|
|
172
|
|
|
173
|
if (!empty($settings['lower case'])) {
|
|
174
|
$output = drupal_strtolower($output);
|
|
175
|
}
|
|
176
|
return $output;
|
|
177
|
}
|
|
178
|
|
|
179
|
/**
|
|
180
|
* A friendly version of truncate_utf8.
|
|
181
|
*
|
|
182
|
* @param $string
|
|
183
|
* The string to be truncated.
|
|
184
|
* @param $length
|
|
185
|
* An integer for the maximum desired length.
|
|
186
|
* @param $separator
|
|
187
|
* A string which contains the word boundary such as - or _.
|
|
188
|
*
|
|
189
|
* @return
|
|
190
|
* The string truncated below the maxlength.
|
|
191
|
*/
|
|
192
|
function ctools_cleanstring_truncate($string, $length, $separator) {
|
|
193
|
if (drupal_strlen($string) > $length) {
|
|
194
|
// Leave one more character.
|
|
195
|
$string = drupal_substr($string, 0, $length + 1);
|
|
196
|
// Space exists AND is not on position 0.
|
|
197
|
if ($last_break = strrpos($string, $separator)) {
|
|
198
|
$string = substr($string, 0, $last_break);
|
|
199
|
}
|
|
200
|
else {
|
|
201
|
$string = drupal_substr($string, 0, $length);
|
|
202
|
}
|
|
203
|
}
|
|
204
|
return $string;
|
|
205
|
}
|
