<?php
+
/**
* Shaarli utilities
*/
/**
- * Logs a message to a text file
+ * Format log using provided data.
*
- * The log format is compatible with fail2ban.
+ * @param string $message the message to log
+ * @param string|null $clientIp the client's remote IPv4/IPv6 address
*
- * @param string $logFile where to write the logs
- * @param string $clientIp the client's remote IPv4/IPv6 address
- * @param string $message the message to log
+ * @return string Formatted message to log
*/
-function logm($logFile, $clientIp, $message)
+function format_log(string $message, string $clientIp = null): string
{
- file_put_contents(
- $logFile,
- date('Y/m/d H:i:s').' - '.$clientIp.' - '.strval($message).PHP_EOL,
- FILE_APPEND
- );
+ $out = $message;
+
+ if (!empty($clientIp)) {
+ // Note: we keep the first dash to avoid breaking fail2ban configs
+ $out = '- ' . $clientIp . ' - ' . $out;
+ }
+
+ return $out;
}
/**
* - are NOT cryptographically secure (they CAN be forged)
*
* In Shaarli, they are used as a tinyurl-like link to individual entries,
- * e.g. smallHash('20111006_131924') --> yZH23w
+ * built once with the combination of the date and item ID.
+ * e.g. smallHash('20111006_131924' . 142) --> eaWxtQ
+ *
+ * @warning before v0.8.1, smallhashes were built only with the date,
+ * and their value has been preserved.
+ *
+ * @param string $text Create a hash from this text.
+ *
+ * @return string generated small hash.
*/
function smallHash($text)
{
*
* @param mixed $input Data to escape: a single string or an array of strings.
*
- * @return string escaped.
+ * @return string|array escaped.
*/
function escape($input)
{
+ if (null === $input) {
+ return null;
+ }
+
+ if (is_bool($input) || is_int($input) || is_float($input) || $input instanceof DateTimeInterface) {
+ return $input;
+ }
+
if (is_array($input)) {
- $out = array();
- foreach($input as $key => $value) {
- $out[$key] = escape($value);
+ $out = [];
+ foreach ($input as $key => $value) {
+ $out[escape($key)] = escape($value);
}
return $out;
}
}
/**
- * Link sanitization before templating
+ * Sanitize link before rendering.
+ *
+ * @param array $link Link to escape.
*/
function sanitizeLink(&$link)
{
*
* @return string $referer - final referer.
*/
-function generateLocation($referer, $host, $loopTerms = array())
+function generateLocation($referer, $host, $loopTerms = [])
{
- $finalReferer = '?';
+ $finalReferer = './?';
// No referer if it contains any value in $loopCriteria.
- foreach ($loopTerms as $value) {
+ foreach (array_filter($loopTerms) as $value) {
if (strpos($referer, $value) !== false) {
return $finalReferer;
}
}
/**
- * Validate session ID to prevent Full Path Disclosure.
+ * Sniff browser language to set the locale automatically.
+ * Note that is may not work on your server if the corresponding locale is not installed.
+ *
+ * @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)
+{
+ // Default if browser does not send HTTP_ACCEPT_LANGUAGE
+ $locales = ['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 (! empty($attempts)) {
+ $locales = array_merge(array_map('implode', $attempts), $locales);
+ }
+ }
+ }
+
+ setlocale(LC_ALL, $locales);
+}
+
+/**
+ * Build a Generator object representing the cartesian product from given $items.
+ *
+ * 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 #298.
- * The session ID's format depends on the hash algorithm set in PHP settings
+ * @see https://en.wikipedia.org/wiki/Cartesian_product
+ */
+function cartesian_product_generator($items)
+{
+ 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];
+ }
+ }
+}
+
+/**
+ * Generates a default API secret.
*
- * @param string $sessionId Session ID
+ * Note that the random-ish methods used in this function are predictable,
+ * which makes them NOT suitable for crypto.
+ * BUT the random string is salted with the salt and hashed with the username.
+ * It makes the generated API secret secured enough for Shaarli.
*
- * @return true if valid, false otherwise.
+ * PHP 7 provides random_int(), designed for cryptography.
+ * More info: http://stackoverflow.com/questions/4356289/php-random-string-generator
+
+ * @param string $username Shaarli login username
+ * @param string $salt Shaarli password hash salt
*
- * @see http://php.net/manual/en/function.hash-algos.php
- * @see http://php.net/manual/en/session.configuration.php
+ * @return string|bool Generated API secret, 12 char length.
+ * Or false if invalid parameters are provided (which will make the API unusable).
*/
-function is_session_id_valid($sessionId)
+function generate_api_secret($username, $salt)
{
- if (empty($sessionId)) {
+ if (empty($username) || empty($salt)) {
return false;
}
- if (!$sessionId) {
+ return str_shuffle(substr(hash_hmac('sha512', uniqid($salt), $username), 10, 12));
+}
+
+/**
+ * Trim string, replace sequences of whitespaces by a single space.
+ * PHP equivalent to `normalize-space` XSLT function.
+ *
+ * @param string $string Input string.
+ *
+ * @return mixed Normalized string.
+ */
+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 DateTimeInterface $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 DateTimeInterface) {
return false;
}
- if (!preg_match('/^[a-zA-Z0-9,-]{2,128}$/', $sessionId)) {
+ 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
+ );
+ $formatter->setTimeZone($date->getTimezone());
+
+ return $formatter->format($date);
+}
+
+/**
+ * Format the date month according to the locale.
+ *
+ * @param DateTimeInterface $date to format.
+ *
+ * @return bool|string Formatted date, or false if the input is invalid.
+ */
+function format_month(DateTimeInterface $date)
+{
+ if (! $date instanceof DateTimeInterface) {
return false;
}
- return true;
+ return strftime('%B', $date->getTimestamp());
}
+
/**
- * In a string, converts URLs to clickable links.
+ * Check if the input is an integer, no matter its real type.
*
- * @param string $text input string.
- * @param string $redirector if a redirector is set, use it to gerenate links.
+ * 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
*
- * @return string returns $text with all links converted to HTML links.
+ * @param mixed $input value
*
- * @see Function inspired from http://www.php.net/manual/en/function.preg-replace.php#85722
+ * @return bool true if the input is an integer, false otherwise
*/
-function text2clickable($text, $redirector)
+function is_integer_mixed($input)
{
- $regex = '!(((?:https?|ftp|file)://|apt:|magnet:)\S+[[:alnum:]]/?)!si';
+ 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)));
+}
- if (empty($redirector)) {
- return preg_replace($regex, '<a href="$1">$1</a>', $text);
+/**
+ * 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;
}
- // Redirector is set, urlencode the final URL.
- return preg_replace_callback(
- $regex,
- function ($matches) use ($redirector) {
- return '<a href="' . $redirector . urlencode($matches[1]) .'">'. $matches[1] .'</a>';
- },
- $text
- );
+ $val = trim($val);
+ $last = strtolower($val[strlen($val) - 1]);
+ $val = intval(substr($val, 0, -1));
+ switch ($last) {
+ case 'g':
+ $val *= 1024;
+ // do no break in order 1024^2 for each unit
+ case 'm':
+ $val *= 1024;
+ // do no break in order 1024^2 for each unit
+ case 'k':
+ $val *= 1024;
+ }
+ return $val;
}
/**
- * This function inserts where relevant so that multiple spaces are properly displayed in HTML
- * even in the absence of <pre> (This is used in description to keep text formatting).
+ * Return a human readable size from bytes.
*
- * @param string $text input text.
+ * @param int $bytes value
*
- * @return string formatted text.
+ * @return string Human readable size
*/
-function space2nbsp($text)
+function human_bytes($bytes)
{
- return preg_replace('/(^| ) /m', '$1 ', $text);
+ 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];
}
/**
- * Format Shaarli's description
- * TODO: Move me to ApplicationUtils when it's ready.
+ * Try to determine max file size for uploads (POST).
+ * Returns an integer (in bytes) or formatted depending on $format.
*
- * @param string $description shaare's description.
- * @param string $redirector if a redirector is set, use it to gerenate links.
+ * @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 string formatted description.
+ * @return int|string max upload file size
*/
-function format_description($description, $redirector = false) {
- return nl2br(space2nbsp(text2clickable($description, $redirector)));
+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;
}
/**
- * Sniff browser language to set the locale automatically.
- * Note that is may not work on your server if the corresponding locale is not installed.
+ * Sort the given array alphabetically using php-intl if available.
+ * Case sensitive.
*
- * @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)
+ * 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)
{
- // 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
- );
+ $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);
}
- setlocale(LC_ALL, $attempts);
+}
+
+/**
+ * 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).
+ * @param array $variables Associative array of variables to replace in translated text.
+ * @param bool $fixCase Apply `ucfirst` on the translated string, might be useful for strings with variables.
+ *
+ * @return string Text translated.
+ */
+function t($text, $nText = '', $nb = 1, $domain = 'shaarli', $variables = [], $fixCase = false)
+{
+ $postFunction = $fixCase ? 'ucfirst' : function ($input) {
+ return $input;
+ };
+
+ return $postFunction(dn__($domain, $text, $nText, $nb, $variables));
+}
+
+/**
+ * Converts an exception into a printable stack trace string.
+ */
+function exception2text(Throwable $e): string
+{
+ return $e->getMessage() . PHP_EOL . $e->getFile() . $e->getLine() . PHP_EOL . $e->getTraceAsString();
}
projects / github / shaarli / Shaarli.git / blobdiff