]>
git.immae.eu Git - github/shaarli/Shaarli.git/blob - application/Utils.php
7 * Returns the small hash of a string, using RFC 4648 base64url format
10 * - are unique (well, as unique as crc32, at last)
11 * - are always 6 characters long.
12 * - only use the following characters: a-z A-Z 0-9 - _ @
13 * - are NOT cryptographically secure (they CAN be forged)
15 * In Shaarli, they are used as a tinyurl-like link to individual entries,
16 * e.g. smallHash('20111006_131924') --> yZH23w
18 function smallHash($text)
20 $t = rtrim(base64_encode(hash('crc32', $text, true)), '=');
21 return strtr($t, '+/', '-_');
25 * Tells if a string start with a substring
27 function startsWith($haystack, $needle, $case=true)
30 return (strcmp(substr($haystack, 0, strlen($needle)), $needle) === 0);
32 return (strcasecmp(substr($haystack, 0, strlen($needle)), $needle) === 0);
36 * Tells if a string ends with a substring
38 function endsWith($haystack, $needle, $case=true)
41 return (strcmp(substr($haystack, strlen($haystack) - strlen($needle)), $needle) === 0);
43 return (strcasecmp(substr($haystack, strlen($haystack) - strlen($needle)), $needle) === 0);
47 * htmlspecialchars wrapper
51 return htmlspecialchars($str, ENT_COMPAT
, 'UTF-8', false);
55 * Link sanitization before templating
57 function sanitizeLink(&$link)
59 $link['url'] = escape($link['url']); // useful?
60 $link['title'] = escape($link['title']);
61 $link['description'] = escape($link['description']);
62 $link['tags'] = escape($link['tags']);
66 * Checks if a string represents a valid date
68 * @param string a string-formatted date
69 * @param format the expected DateTime format of the string
70 * @return whether the string is a valid date
71 * @see http://php.net/manual/en/class.datetime.php
72 * @see http://php.net/manual/en/datetime.createfromformat.php
74 function checkDateFormat($format, $string)
76 $date = DateTime
::createFromFormat($format, $string);
77 return $date && $date->format($string) == $string;
81 * Generate a header location from HTTP_REFERER.
82 * Make sure the referer is Shaarli itself and prevent redirection loop.
84 * @param string $referer - HTTP_REFERER.
85 * @param string $host - Server HOST.
86 * @param array $loopTerms - Contains list of term to prevent redirection loop.
88 * @return string $referer - final referer.
90 function generateLocation($referer, $host, $loopTerms = array())
94 // No referer if it contains any value in $loopCriteria.
95 foreach ($loopTerms as $value) {
96 if (strpos($referer, $value) !== false) {
101 // Remove port from HTTP_HOST
102 if ($pos = strpos($host, ':')) {
103 $host = substr($host, 0, $pos);
106 $refererHost = parse_url($referer, PHP_URL_HOST
);
107 if (!empty($referer) && (strpos($refererHost, $host) !== false || startsWith('?', $refererHost))) {
108 $finalReferer = $referer;
111 return $finalReferer;
115 * Validate session ID to prevent Full Path Disclosure.
118 * The session ID's format depends on the hash algorithm set in PHP settings
120 * @param string $sessionId Session ID
122 * @return true if valid, false otherwise.
124 * @see http://php.net/manual/en/function.hash-algos.php
125 * @see http://php.net/manual/en/session.configuration.php
127 function is_session_id_valid($sessionId)
129 if (empty($sessionId)) {
137 if (!preg_match('/^[a-zA-Z0-9,-]{2,128}$/', $sessionId)) {
145 * In a string, converts URLs to clickable links.
147 * @param string $text input string.
148 * @param string $redirector if a redirector is set, use it to gerenate links.
150 * @return string returns $text with all links converted to HTML links.
152 * @see Function inspired from http://www.php.net/manual/en/function.preg-replace.php#85722
154 function text2clickable($text, $redirector)
156 $regex = '!(((?:https?|ftp|file)://|apt:|magnet:)\S+[[:alnum:]]/?)!si';
158 if (empty($redirector)) {
159 return preg_replace($regex, '<a href="$1">$1</a>', $text);
161 // Redirector is set, urlencode the final URL.
162 return preg_replace_callback(
164 function ($matches) use ($redirector) {
165 return '<a href="' . $redirector . urlencode($matches[1]) .'">'. $matches[1] .'</a>';
172 * This function inserts where relevant so that multiple spaces are properly displayed in HTML
173 * even in the absence of <pre> (This is used in description to keep text formatting).
175 * @param string $text input text.
177 * @return string formatted text.
179 function space2nbsp($text)
181 return preg_replace('/(^| ) /m', '$1 ', $text);
185 * Format Shaarli's description
186 * TODO: Move me to ApplicationUtils when it's ready.
188 * @param string $description shaare's description.
189 * @param string $redirector if a redirector is set, use it to gerenate links.
191 * @return string formatted description.
193 function format_description($description, $redirector) {
194 return nl2br(space2nbsp(text2clickable($description, $redirector)));