X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=application%2FUtils.php;h=925e1a22c909011a342b3dc3ced3c9f0f5d9a3da;hb=f211e417bf637b8a83988175c29ee072c69f7642;hp=35d652241bb6a5a4c42c7ded7b7381be48dc7f15;hpb=a0df06517bada0f811b464017ce385290e02c2bf;p=github%2Fshaarli%2FShaarli.git diff --git a/application/Utils.php b/application/Utils.php index 35d65224..925e1a22 100644 --- a/application/Utils.php +++ b/application/Utils.php @@ -91,9 +91,13 @@ function endsWith($haystack, $needle, $case = true) */ function escape($input) { + if (is_bool($input)) { + return $input; + } + if (is_array($input)) { $out = array(); - foreach($input as $key => $value) { + foreach ($input as $key => $value) { $out[$key] = escape($value); } return $out; @@ -178,58 +182,71 @@ function generateLocation($referer, $host, $loopTerms = array()) } /** - * Validate session ID to prevent Full Path Disclosure. - * - * See #298. - * The session ID's format depends on the hash algorithm set in PHP settings - * - * @param string $sessionId Session ID - * - * @return true if valid, false otherwise. + * Sniff browser language to set the locale automatically. + * Note that is may not work on your server if the corresponding locale is not installed. * - * @see http://php.net/manual/en/function.hash-algos.php - * @see http://php.net/manual/en/session.configuration.php - */ -function is_session_id_valid($sessionId) + * @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"). + **/ +function autoLocale($headerLocale) { - if (empty($sessionId)) { - return false; - } - - if (!$sessionId) { - return false; - } + // Default if browser does not send HTTP_ACCEPT_LANGUAGE + $locales = array('en_US', 'en_US.utf8', 'en_US.UTF-8'); + if (! empty($headerLocale)) { + if (preg_match_all('/([a-z]{2,3})[-_]?([a-z]{2})?,?/i', $headerLocale, $matches, PREG_SET_ORDER)) { + $attempts = []; + foreach ($matches as $match) { + $first = [strtolower($match[1]), strtoupper($match[1])]; + $separators = ['_', '-']; + $encodings = ['utf8', 'UTF-8']; + if (!empty($match[2])) { + $second = [strtoupper($match[2]), strtolower($match[2])]; + $items = [$first, $separators, $second, ['.'], $encodings]; + } else { + $items = [$first, $separators, $first, ['.'], $encodings]; + } + $attempts = array_merge($attempts, iterator_to_array(cartesian_product_generator($items))); + } - if (!preg_match('/^[a-zA-Z0-9,-]{2,128}$/', $sessionId)) { - return false; + if (! empty($attempts)) { + $locales = array_merge(array_map('implode', $attempts), $locales); + } + } } - return true; + setlocale(LC_ALL, $locales); } /** - * Sniff browser language to set the locale automatically. - * Note that is may not work on your server if the corresponding locale is not installed. + * Build a Generator object representing the cartesian product from given $items. * - * @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"). - **/ -function autoLocale($headerLocale) + * Example: + * [['a'], ['b', 'c']] + * will generate: + * [ + * ['a', 'b'], + * ['a', 'c'], + * ] + * + * @param array $items array of array of string + * + * @return Generator representing the cartesian product of given array. + * + * @see https://en.wikipedia.org/wiki/Cartesian_product + */ +function cartesian_product_generator($items) { - // Default if browser does not send HTTP_ACCEPT_LANGUAGE - $attempts = array('en_US'); - if (isset($headerLocale)) { - // (It's a bit crude, but it works very well. Preferred language is always presented first.) - if (preg_match('/([a-z]{2})-?([a-z]{2})?/i', $headerLocale, $matches)) { - $loc = $matches[1] . (!empty($matches[2]) ? '_' . strtoupper($matches[2]) : ''); - $attempts = array( - $loc.'.UTF-8', $loc, str_replace('_', '-', $loc).'.UTF-8', str_replace('_', '-', $loc), - $loc . '_' . strtoupper($loc).'.UTF-8', $loc . '_' . strtoupper($loc), - $loc . '_' . $loc.'.UTF-8', $loc . '_' . $loc, $loc . '-' . strtoupper($loc).'.UTF-8', - $loc . '-' . strtoupper($loc), $loc . '-' . $loc.'.UTF-8', $loc . '-' . $loc - ); + if (empty($items)) { + yield []; + } + $subArray = array_pop($items); + if (empty($subArray)) { + return; + } + foreach (cartesian_product_generator($items) as $item) { + foreach ($subArray as $value) { + yield $item + [count($item) => $value]; } } - setlocale(LC_ALL, $attempts); } /** @@ -270,3 +287,175 @@ function normalize_spaces($string) { return preg_replace('/\s{2,}/', ' ', trim($string)); } + +/** + * Format the date according to the locale. + * + * Requires php-intl to display international datetimes, + * otherwise default format '%c' will be returned. + * + * @param DateTime $date to format. + * @param bool $time Displays time if true. + * @param bool $intl Use international format if true. + * + * @return bool|string Formatted date, or false if the input is invalid. + */ +function format_date($date, $time = true, $intl = true) +{ + if (! $date instanceof DateTime) { + return false; + } + + if (! $intl || ! class_exists('IntlDateFormatter')) { + $format = $time ? '%c' : '%x'; + return strftime($format, $date->getTimestamp()); + } + + $formatter = new IntlDateFormatter( + setlocale(LC_TIME, 0), + IntlDateFormatter::LONG, + $time ? IntlDateFormatter::LONG : IntlDateFormatter::NONE + ); + + return $formatter->format($date); +} + +/** + * Check if the input is an integer, no matter its real type. + * + * PHP is a bit messy regarding this: + * - is_int returns false if the input is a string + * - ctype_digit returns false if the input is an integer or negative + * + * @param mixed $input value + * + * @return bool true if the input is an integer, false otherwise + */ +function is_integer_mixed($input) +{ + if (is_array($input) || is_bool($input) || is_object($input)) { + return false; + } + $input = strval($input); + return ctype_digit($input) || (startsWith($input, '-') && ctype_digit(substr($input, 1))); +} + +/** + * Convert post_max_size/upload_max_filesize (e.g. '16M') parameters to bytes. + * + * @param string $val Size expressed in string. + * + * @return int Size expressed in bytes. + */ +function return_bytes($val) +{ + if (is_integer_mixed($val) || $val === '0' || empty($val)) { + return $val; + } + $val = trim($val); + $last = strtolower($val[strlen($val)-1]); + $val = intval(substr($val, 0, -1)); + switch ($last) { + case 'g': + $val *= 1024; + case 'm': + $val *= 1024; + case 'k': + $val *= 1024; + } + return $val; +} + +/** + * Return a human readable size from bytes. + * + * @param int $bytes value + * + * @return string Human readable size + */ +function human_bytes($bytes) +{ + if ($bytes === '') { + return t('Setting not set'); + } + if (! is_integer_mixed($bytes)) { + return $bytes; + } + $bytes = intval($bytes); + if ($bytes === 0) { + return t('Unlimited'); + } + + $units = [t('B'), t('kiB'), t('MiB'), t('GiB')]; + for ($i = 0; $i < count($units) && $bytes >= 1024; ++$i) { + $bytes /= 1024; + } + + return round($bytes) . $units[$i]; +} + +/** + * Try to determine max file size for uploads (POST). + * Returns an integer (in bytes) or formatted depending on $format. + * + * @param mixed $limitPost post_max_size PHP setting + * @param mixed $limitUpload upload_max_filesize PHP setting + * @param bool $format Format max upload size to human readable size + * + * @return int|string max upload file size + */ +function get_max_upload_size($limitPost, $limitUpload, $format = true) +{ + $size1 = return_bytes($limitPost); + $size2 = return_bytes($limitUpload); + // Return the smaller of two: + $maxsize = min($size1, $size2); + return $format ? human_bytes($maxsize) : $maxsize; +} + +/** + * Sort the given array alphabetically using php-intl if available. + * Case sensitive. + * + * Note: doesn't support multidimensional arrays + * + * @param array $data Input array, passed by reference + * @param bool $reverse Reverse sort if set to true + * @param bool $byKeys Sort the array by keys if set to true, by value otherwise. + */ +function alphabetical_sort(&$data, $reverse = false, $byKeys = false) +{ + $callback = function ($a, $b) use ($reverse) { + // Collator is part of PHP intl. + if (class_exists('Collator')) { + $collator = new Collator(setlocale(LC_COLLATE, 0)); + if (!intl_is_failure(intl_get_error_code())) { + return $collator->compare($a, $b) * ($reverse ? -1 : 1); + } + } + + return strcasecmp($a, $b) * ($reverse ? -1 : 1); + }; + + if ($byKeys) { + uksort($data, $callback); + } else { + usort($data, $callback); + } +} + +/** + * Wrapper function for translation which match the API + * of gettext()/_() and ngettext(). + * + * @param string $text Text to translate. + * @param string $nText The plural message ID. + * @param int $nb The number of items for plural forms. + * @param string $domain The domain where the translation is stored (default: shaarli). + * + * @return string Text translated. + */ +function t($text, $nText = '', $nb = 1, $domain = 'shaarli') +{ + return dn__($domain, $text, $nText, $nb); +}