]>
git.immae.eu Git - github/shaarli/Shaarli.git/blob - application/Utils.php
19fb7116f0535402119250855a6fe74f09b4a5c2
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 $attempts = array('en_US', 'en_US.utf8', 'en_US.UTF-8');
220 if (isset($headerLocale)) {
221 // (It's a bit crude, but it works very well. Preferred language is always presented first.)
222 if (preg_match('/([a-z]{2,3})[-_]?([a-z]{2})?/i', $headerLocale, $matches)) {
223 $first = [strtolower($matches[1]), strtoupper($matches[1])];
224 $separators = ['_', '-'];
225 $encodings = ['utf8', 'UTF-8'];
226 if (!empty($matches[2])) {
227 $second = [strtoupper($matches[2]), strtolower($matches[2])];
228 $attempts = arrays_combination([$first, $separators, $second, ['.'], $encodings]);
230 $attempts = arrays_combination([$first, $separators, $first, ['.'], $encodings]);
234 setlocale(LC_ALL
, $attempts);
238 * Combine multiple arrays of string to get all possible strings.
239 * The order is important because this doesn't shuffle the entries.
242 * [['a'], ['b', 'c']]
247 * TODO PHP 5.6: use the `...` operator instead of an array of array.
249 * @param array $items array of array of string
251 * @return array Combined string from the input array.
253 function arrays_combination($items)
256 foreach ($items as $item) {
258 foreach ($item as $element) {
259 foreach ($out as $key => $existingEntry) {
260 $add[] = $existingEntry . $element;
269 * Generates a default API secret.
271 * Note that the random-ish methods used in this function are predictable,
272 * which makes them NOT suitable for crypto.
273 * BUT the random string is salted with the salt and hashed with the username.
274 * It makes the generated API secret secured enough for Shaarli.
276 * PHP 7 provides random_int(), designed for cryptography.
277 * More info: http://stackoverflow.com/questions/4356289/php-random-string-generator
279 * @param string $username Shaarli login username
280 * @param string $salt Shaarli password hash salt
282 * @return string|bool Generated API secret, 12 char length.
283 * Or false if invalid parameters are provided (which will make the API unusable).
285 function generate_api_secret($username, $salt)
287 if (empty($username) || empty($salt)) {
291 return str_shuffle(substr(hash_hmac('sha512', uniqid($salt), $username), 10, 12));
295 * Trim string, replace sequences of whitespaces by a single space.
296 * PHP equivalent to `normalize-space` XSLT function.
298 * @param string $string Input string.
300 * @return mixed Normalized string.
302 function normalize_spaces($string)
304 return preg_replace('/\s{2,}/', ' ', trim($string));