3 * @file src/Util/Strings.php
6 namespace Friendica\Util;
8 use Friendica\Content\ContactSelector;
9 use Friendica\Core\Logger;
12 * @brief This class handles string functions
17 * @brief Generates a pseudo-random string of hexadecimal characters
23 public static function getRandomHex($size = 64)
25 $byte_size = ceil($size / 2);
27 $bytes = random_bytes($byte_size);
29 $return = substr(bin2hex($bytes), 0, $size);
35 * Checks, if the given string is a valid hexadecimal code
37 * @param string $hexCode
41 public static function isHex($hexCode)
43 return !empty($hexCode) ? @preg_match("/^[a-f0-9]{2,}$/i", $hexCode) && !(strlen($hexCode) & 1) : false;
47 * @brief This is our primary input filter.
49 * Use this on any text input where angle chars are not valid or permitted
50 * They will be replaced with safer brackets. This may be filtered further
51 * if these are not allowed either.
53 * @param string $string Input string
54 * @return string Filtered string
56 public static function escapeTags($string)
58 return str_replace(["<", ">"], ['[', ']'], $string);
62 * @brief Use this on "body" or "content" input where angle chars shouldn't be removed,
63 * and allow them to be safely displayed.
64 * @param string $string
68 public static function escapeHtml($string)
70 return htmlspecialchars($string, ENT_COMPAT, 'UTF-8', false);
74 * @brief Generate a string that's random, but usually pronounceable. Used to generate initial passwords
76 * @param int $len length
80 public static function getRandomName($len)
86 $vowels = ['a', 'a', 'ai', 'au', 'e', 'e', 'e', 'ee', 'ea', 'i', 'ie', 'o', 'ou', 'u'];
88 if (mt_rand(0, 5) == 4) {
94 'c', 'ch', 'cl', 'cr',
97 'g', 'gh', 'gl', 'gr',
100 'k', 'kh', 'kl', 'kr',
104 'p', 'ph', 'pl', 'pr',
107 's' ,'sc', 'sh', 'sm', 'sp', 'st',
115 $midcons = ['ck', 'ct', 'gn', 'ld', 'lf', 'lm', 'lt', 'mb', 'mm', 'mn', 'mp',
116 'nd', 'ng', 'nk', 'nt', 'rn', 'rp', 'rt'];
118 $noend = ['bl', 'br', 'cl', 'cr', 'dr', 'fl', 'fr', 'gl', 'gr',
119 'kh', 'kl', 'kr', 'mn', 'pl', 'pr', 'rh', 'tr', 'qu', 'wh', 'q'];
121 $start = mt_rand(0, 2);
130 for ($x = 0; $x < $len; $x ++) {
131 $r = mt_rand(0, count($table) - 1);
134 if ($table == $vowels) {
135 $table = array_merge($cons, $midcons);
142 $word = substr($word, 0, $len);
144 foreach ($noend as $noe) {
145 $noelen = strlen($noe);
146 if ((strlen($word) > $noelen) && (substr($word, -$noelen) == $noe)) {
147 $word = self::getRandomName($len);
156 * Translate and format the network name of a contact
158 * @param string $network Network name of the contact (e.g. dfrn, rss and so on)
159 * @param string $url The contact url
161 * @return string Formatted network name
162 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
164 public static function formatNetworkName($network, $url = '')
166 if ($network != '') {
168 $network_name = '<a href="' . $url .'">' . ContactSelector::networkToName($network, $url) . '</a>';
170 $network_name = ContactSelector::networkToName($network);
173 return $network_name;
178 * @brief Remove indentation from a text
180 * @param string $text String to be transformed.
181 * @param string $chr Optional. Indentation tag. Default tab (\t).
182 * @param int $count Optional. Default null.
184 * @return string Transformed string.
186 public static function deindent($text, $chr = "[\t ]", $count = NULL)
188 $lines = explode("\n", $text);
190 if (is_null($count)) {
193 while ($k < count($lines) && strlen($lines[$k]) == 0) {
196 preg_match("|^" . $chr . "*|", $lines[$k], $m);
197 $count = strlen($m[0]);
200 for ($k = 0; $k < count($lines); $k++) {
201 $lines[$k] = preg_replace("|^" . $chr . "{" . $count . "}|", "", $lines[$k]);
204 return implode("\n", $lines);
208 * @brief Get byte size returned in a Data Measurement (KB, MB, GB)
210 * @param int $bytes The number of bytes to be measured
211 * @param int $precision Optional. Default 2.
213 * @return string Size with measured units.
215 public static function formatBytes($bytes, $precision = 2)
217 $units = ['B', 'KB', 'MB', 'GB', 'TB'];
218 $bytes = max($bytes, 0);
219 $pow = floor(($bytes ? log($bytes) : 0) / log(1024));
220 $pow = min($pow, count($units) - 1);
221 $bytes /= pow(1024, $pow);
223 return round($bytes, $precision) . ' ' . $units[$pow];
227 * @brief Protect percent characters in sprintf calls
229 * @param string $s String to transform.
231 * @return string Transformed string.
233 public static function protectSprintf($s)
235 return str_replace('%', '%%', $s);
239 * @brief Base64 Encode URL and translate +/ to -_ Optionally strip padding.
241 * @param string $s URL to encode
242 * @param boolean $strip_padding Optional. Default false
244 * @return string Encoded URL
246 public static function base64UrlEncode($s, $strip_padding = false)
248 $s = strtr(base64_encode($s), '+/', '-_');
250 if ($strip_padding) {
251 $s = str_replace('=', '', $s);
258 * @brief Decode Base64 Encoded URL and translate -_ to +/
259 * @param string $s URL to decode
261 * @return string Decoded URL
264 public static function base64UrlDecode($s)
267 Logger::log('base64url_decode: illegal input: ' . print_r(debug_backtrace(), true));
272 * // Placeholder for new rev of salmon which strips base64 padding.
273 * // PHP base64_decode handles the un-padded input without requiring this step
274 * // Uncomment if you find you need it.
277 * if (!strpos($s,'=')) {
287 return base64_decode(strtr($s, '-_', '+/'));
291 * @brief Normalize url
293 * @param string $url URL to be normalized.
295 * @return string Normalized URL.
297 public static function normaliseLink($url)
299 $ret = str_replace(['https:', '//www.'], ['http:', '//'], $url);
300 return rtrim($ret, '/');
304 * @brief Normalize OpenID identity
306 * @param string $s OpenID Identity
308 * @return string normalized OpenId Identity
310 public static function normaliseOpenID($s)
312 return trim(str_replace(['http://', 'https://'], ['', ''], $s), '/');
316 * @brief Compare two URLs to see if they are the same, but ignore
317 * slight but hopefully insignificant differences such as if one
318 * is https and the other isn't, or if one is www.something and
319 * the other isn't - and also ignore case differences.
321 * @param string $a first url
322 * @param string $b second url
323 * @return boolean True if the URLs match, otherwise False
326 public static function compareLink($a, $b)
328 return (strcasecmp(self::normaliseLink($a), self::normaliseLink($b)) === 0);
333 * Ensures the provided URI has its query string punctuation in order.
338 public static function ensureQueryParameter($uri)
340 if (strpos($uri, '?') === false && ($pos = strpos($uri, '&')) !== false) {
341 $uri = substr($uri, 0, $pos) . '?' . substr($uri, $pos + 1);
349 * Check if the trimmed provided string is starting with one of the provided characters
351 * @param string $string
352 * @param array $chars
355 public static function startsWith($string, array $chars)
357 $return = in_array(substr(trim($string), 0, 1), $chars);
363 * Returns the regular expression string to match URLs in a given text
366 * @see https://daringfireball.net/2010/07/improved_regex_for_matching_urls
368 public static function autoLinkRegEx()
371 (?<![=\'\]"/]) # Not preceded by [, =, \', ], ", /
373 ( # Capture 1: entire matched URL
374 https?:// # http or https protocol
376 [^/\s\xA0`!()\[\]{};:\'",<>?«»“”‘’.] # Domain can\'t start with a .
377 [^/\s\xA0`!()\[\]{};:\'",<>?«»“”‘’]+ # Domain can\'t end with a .
379 [^/\s\xA0`!()\[\]{};:\'".,<>?«»“”‘’]+/? # Followed by a slash
382 [^\s\xA0()<>]+ # Run of non-space, non-()<>
384 \(([^\s\xA0()<>]+|(\([^\s()<>]+\)))*\) # balanced parens, up to 2 levels
386 [^\s\xA0`!()\[\]{};:\'".,<>?«»“”‘’] # not a space or one of these punct chars
392 * Ensures a single path item doesn't contain any path-traversing characters
394 * @see https://stackoverflow.com/a/46097713
395 * @param string $pathItem
398 public static function sanitizeFilePathItem($pathItem)
400 $pathItem = str_replace('/', '_', $pathItem);
401 $pathItem = str_replace('\\', '_', $pathItem);
402 $pathItem = str_replace(DIRECTORY_SEPARATOR, '_', $pathItem); // In case it does not equal the standard values