]>
git.immae.eu Git - github/shaarli/Shaarli.git/blob - application/Utils.php
7 * Logs a message to a text file
9 * The log format is compatible with fail2ban.
11 * @param string $logFile where to write the logs
12 * @param string $clientIp the client's remote IPv4/IPv6 address
13 * @param string $message the message to log
15 function logm($logFile, $clientIp, $message)
19 date('Y/m/d H:i:s').' - '.$clientIp.' - '.strval($message).PHP_EOL
,
25 * Returns the small hash of a string, using RFC 4648 base64url format
28 * - are unique (well, as unique as crc32, at last)
29 * - are always 6 characters long.
30 * - only use the following characters: a-z A-Z 0-9 - _ @
31 * - are NOT cryptographically secure (they CAN be forged)
33 * In Shaarli, they are used as a tinyurl-like link to individual entries,
34 * built once with the combination of the date and item ID.
35 * e.g. smallHash('20111006_131924' . 142) --> eaWxtQ
37 * @warning before v0.8.1, smallhashes were built only with the date,
38 * and their value has been preserved.
40 * @param string $text Create a hash from this text.
42 * @return string generated small hash.
44 function smallHash($text)
46 $t = rtrim(base64_encode(hash('crc32', $text, true)), '=');
47 return strtr($t, '+/', '-_');
51 * Tells if a string start with a substring
53 * @param string $haystack Given string.
54 * @param string $needle String to search at the beginning of $haystack.
55 * @param bool $case Case sensitive.
57 * @return bool True if $haystack starts with $needle.
59 function startsWith($haystack, $needle, $case = true)
62 return (strcmp(substr($haystack, 0, strlen($needle)), $needle) === 0);
64 return (strcasecmp(substr($haystack, 0, strlen($needle)), $needle) === 0);
68 * Tells if a string ends with a substring
70 * @param string $haystack Given string.
71 * @param string $needle String to search at the end of $haystack.
72 * @param bool $case Case sensitive.
74 * @return bool True if $haystack ends with $needle.
76 function endsWith($haystack, $needle, $case = true)
79 return (strcmp(substr($haystack, strlen($haystack) - strlen($needle)), $needle) === 0);
81 return (strcasecmp(substr($haystack, strlen($haystack) - strlen($needle)), $needle) === 0);
85 * Htmlspecialchars wrapper
86 * Support multidimensional array of strings.
88 * @param mixed $input Data to escape: a single string or an array of strings.
90 * @return string escaped.
92 function escape($input)
94 if (is_array($input)) {
96 foreach($input as $key => $value) {
97 $out[$key] = escape($value);
101 return htmlspecialchars($input, ENT_COMPAT
, 'UTF-8', false);
105 * Reverse the escape function.
107 * @param string $str the string to unescape.
109 * @return string unescaped string.
111 function unescape($str)
113 return htmlspecialchars_decode($str);
117 * Sanitize link before rendering.
119 * @param array $link Link to escape.
121 function sanitizeLink(&$link)
123 $link['url'] = escape($link['url']); // useful?
124 $link['title'] = escape($link['title']);
125 $link['description'] = escape($link['description']);
126 $link['tags'] = escape($link['tags']);
130 * Checks if a string represents a valid date
132 * @param string $format The expected DateTime format of the string
133 * @param string $string A string-formatted date
135 * @return bool whether the string is a valid date
137 * @see http://php.net/manual/en/class.datetime.php
138 * @see http://php.net/manual/en/datetime.createfromformat.php
140 function checkDateFormat($format, $string)
142 $date = DateTime
::createFromFormat($format, $string);
143 return $date && $date->format($string) == $string;
147 * Generate a header location from HTTP_REFERER.
148 * Make sure the referer is Shaarli itself and prevent redirection loop.
150 * @param string $referer - HTTP_REFERER.
151 * @param string $host - Server HOST.
152 * @param array $loopTerms - Contains list of term to prevent redirection loop.
154 * @return string $referer - final referer.
156 function generateLocation($referer, $host, $loopTerms = array())
160 // No referer if it contains any value in $loopCriteria.
161 foreach ($loopTerms as $value) {
162 if (strpos($referer, $value) !== false) {
163 return $finalReferer;
167 // Remove port from HTTP_HOST
168 if ($pos = strpos($host, ':')) {
169 $host = substr($host, 0, $pos);
172 $refererHost = parse_url($referer, PHP_URL_HOST
);
173 if (!empty($referer) && (strpos($refererHost, $host) !== false || startsWith('?', $refererHost))) {
174 $finalReferer = $referer;
177 return $finalReferer;
181 * Validate session ID to prevent Full Path Disclosure.
184 * The session ID's format depends on the hash algorithm set in PHP settings
186 * @param string $sessionId Session ID
188 * @return true if valid, false otherwise.
190 * @see http://php.net/manual/en/function.hash-algos.php
191 * @see http://php.net/manual/en/session.configuration.php
193 function is_session_id_valid($sessionId)
195 if (empty($sessionId)) {
203 if (!preg_match('/^[a-zA-Z0-9,-]{2,128}$/', $sessionId)) {
211 * Sniff browser language to set the locale automatically.
212 * Note that is may not work on your server if the corresponding locale is not installed.
214 * @param string $headerLocale Locale send in HTTP headers (e.g. "fr,fr-fr;q=0.8,en;q=0.5,en-us;q=0.3").
216 function autoLocale($headerLocale)
218 // Default if browser does not send HTTP_ACCEPT_LANGUAGE
219 $locales = array('en_US', 'en_US.utf8', 'en_US.UTF-8');
220 if (! empty($headerLocale)) {
221 if (preg_match_all('/([a-z]{2,3})[-_]?([a-z]{2})?,?/i', $headerLocale, $matches, PREG_SET_ORDER
)) {
223 foreach ($matches as $match) {
224 $first = [strtolower($match[1]), strtoupper($match[1])];
225 $separators = ['_', '-'];
226 $encodings = ['utf8', 'UTF-8'];
227 if (!empty($match[2])) {
228 $second = [strtoupper($match[2]), strtolower($match[2])];
229 $items = [$first, $separators, $second, ['.'], $encodings];
231 $items = [$first, $separators, $first, ['.'], $encodings];
233 $attempts = array_merge($attempts, iterator_to_array(cartesian_product_generator($items)));
236 if (! empty($attempts)) {
237 $locales = array_merge(array_map('implode', $attempts), $locales);
242 setlocale(LC_ALL
, $locales);
246 * Build a Generator object representing the cartesian product from given $items.
249 * [['a'], ['b', 'c']]
256 * @param array $items array of array of string
258 * @return Generator representing the cartesian product of given array.
260 * @see https://en.wikipedia.org/wiki/Cartesian_product
262 function cartesian_product_generator($items)
267 $subArray = array_pop($items);
268 if (empty($subArray)) {
271 foreach (cartesian_product_generator($items) as $item) {
272 foreach ($subArray as $value) {
273 yield
$item +
[count($item) => $value];
279 * Generates a default API secret.
281 * Note that the random-ish methods used in this function are predictable,
282 * which makes them NOT suitable for crypto.
283 * BUT the random string is salted with the salt and hashed with the username.
284 * It makes the generated API secret secured enough for Shaarli.
286 * PHP 7 provides random_int(), designed for cryptography.
287 * More info: http://stackoverflow.com/questions/4356289/php-random-string-generator
289 * @param string $username Shaarli login username
290 * @param string $salt Shaarli password hash salt
292 * @return string|bool Generated API secret, 12 char length.
293 * Or false if invalid parameters are provided (which will make the API unusable).
295 function generate_api_secret($username, $salt)
297 if (empty($username) || empty($salt)) {
301 return str_shuffle(substr(hash_hmac('sha512', uniqid($salt), $username), 10, 12));
305 * Trim string, replace sequences of whitespaces by a single space.
306 * PHP equivalent to `normalize-space` XSLT function.
308 * @param string $string Input string.
310 * @return mixed Normalized string.
312 function normalize_spaces($string)
314 return preg_replace('/\s{2,}/', ' ', trim($string));
318 * Format the date according to the locale.
320 * Requires php-intl to display international datetimes,
321 * otherwise default format '%c' will be returned.
323 * @param DateTime $date to format.
324 * @param bool $time Displays time if true.
325 * @param bool $intl Use international format if true.
327 * @return bool|string Formatted date, or false if the input is invalid.
329 function format_date($date, $time = true, $intl = true)
331 if (! $date instanceof DateTime
) {
335 if (! $intl || ! class_exists('IntlDateFormatter')) {
336 $format = $time ? '%c' : '%x';
337 return strftime($format, $date->getTimestamp());
340 $formatter = new IntlDateFormatter(
341 setlocale(LC_TIME
, 0),
342 IntlDateFormatter
::LONG
,
343 $time ? IntlDateFormatter
::LONG
: IntlDateFormatter
::NONE
346 return $formatter->format($date);
350 * Check if the input is an integer, no matter its real type.
352 * PHP is a bit messy regarding this:
353 * - is_int returns false if the input is a string
354 * - ctype_digit returns false if the input is an integer or negative
356 * @param mixed $input value
358 * @return bool true if the input is an integer, false otherwise
360 function is_integer_mixed($input)
362 if (is_array($input) || is_bool($input) || is_object($input)) {
365 $input = strval($input);
366 return ctype_digit($input) || (startsWith($input, '-') && ctype_digit(substr($input, 1)));
370 * Convert post_max_size/upload_max_filesize (e.g. '16M') parameters to bytes.
372 * @param string $val Size expressed in string.
374 * @return int Size expressed in bytes.
376 function return_bytes($val)
378 if (is_integer_mixed($val) || $val === '0' || empty($val)) {
382 $last = strtolower($val[strlen($val)-1]);
383 $val = intval(substr($val, 0, -1));
385 case 'g': $val *= 1024;
386 case 'm': $val *= 1024;
387 case 'k': $val *= 1024;
393 * Return a human readable size from bytes.
395 * @param int $bytes value
397 * @return string Human readable size
399 function human_bytes($bytes)
402 return t('Setting not set');
404 if (! is_integer_mixed($bytes)) {
407 $bytes = intval($bytes);
409 return t('Unlimited');
412 $units = [t('B'), t('kiB'), t('MiB'), t('GiB')];
413 for ($i = 0; $i < count($units) && $bytes >= 1024; ++
$i) {
417 return round($bytes) . $units[$i];
421 * Try to determine max file size for uploads (POST).
422 * Returns an integer (in bytes) or formatted depending on $format.
424 * @param mixed $limitPost post_max_size PHP setting
425 * @param mixed $limitUpload upload_max_filesize PHP setting
426 * @param bool $format Format max upload size to human readable size
428 * @return int|string max upload file size
430 function get_max_upload_size($limitPost, $limitUpload, $format = true)
432 $size1 = return_bytes($limitPost);
433 $size2 = return_bytes($limitUpload);
434 // Return the smaller of two:
435 $maxsize = min($size1, $size2);
436 return $format ? human_bytes($maxsize) : $maxsize;