]>
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 * Same as nl2br(), but escapes < and >
49 function nl2br_escaped($html)
51 return str_replace('>', '>', str_replace('<', '<', nl2br($html)));
55 * htmlspecialchars wrapper
59 return htmlspecialchars($str, ENT_COMPAT
, 'UTF-8', false);
63 * Link sanitization before templating
65 function sanitizeLink(&$link)
67 $link['url'] = escape($link['url']); // useful?
68 $link['title'] = escape($link['title']);
69 $link['description'] = escape($link['description']);
70 $link['tags'] = escape($link['tags']);
74 * Checks if a string represents a valid date
76 * @param string a string-formatted date
77 * @param format the expected DateTime format of the string
78 * @return whether the string is a valid date
79 * @see http://php.net/manual/en/class.datetime.php
80 * @see http://php.net/manual/en/datetime.createfromformat.php
82 function checkDateFormat($format, $string)
84 $date = DateTime
::createFromFormat($format, $string);
85 return $date && $date->format($string) == $string;
89 * Generate a header location from HTTP_REFERER.
90 * Make sure the referer is Shaarli itself and prevent redirection loop.
92 * @param string $referer - HTTP_REFERER.
93 * @param string $host - Server HOST.
94 * @param array $loopTerms - Contains list of term to prevent redirection loop.
96 * @return string $referer - final referer.
98 function generateLocation($referer, $host, $loopTerms = array())
102 // No referer if it contains any value in $loopCriteria.
103 foreach ($loopTerms as $value) {
104 if (strpos($referer, $value) !== false) {
105 return $finalReferer;
109 // Remove port from HTTP_HOST
110 if ($pos = strpos($host, ':')) {
111 $host = substr($host, 0, $pos);
114 $refererHost = parse_url($referer, PHP_URL_HOST
);
115 if (!empty($referer) && (strpos($refererHost, $host) !== false || startsWith('?', $refererHost))) {
116 $finalReferer = $referer;
119 return $finalReferer;
123 * Validate session ID to prevent Full Path Disclosure.
126 * The session ID's format depends on the hash algorithm set in PHP settings
128 * @param string $sessionId Session ID
130 * @return true if valid, false otherwise.
132 * @see http://php.net/manual/en/function.hash-algos.php
133 * @see http://php.net/manual/en/session.configuration.php
135 function is_session_id_valid($sessionId)
137 if (empty($sessionId)) {
145 if (!preg_match('/^[a-zA-Z0-9,-]{2,128}$/', $sessionId)) {
153 * In a string, converts URLs to clickable links.
155 * @param string $text input string.
156 * @param string $redirector if a redirector is set, use it to gerenate links.
158 * @return string returns $text with all links converted to HTML links.
160 * @see Function inspired from http://www.php.net/manual/en/function.preg-replace.php#85722
162 function text2clickable($text, $redirector)
164 $regex = '!(((?:https?|ftp|file)://|apt:|magnet:)\S+[[:alnum:]]/?)!si';
166 if (empty($redirector)) {
167 return preg_replace($regex, '<a href="$1">$1</a>', $text);
169 // Redirector is set, urlencode the final URL.
170 return preg_replace_callback(
172 function ($matches) use ($redirector) {
173 return '<a href="' . $redirector . urlencode($matches[1]) .'">'. $matches[1] .'</a>';
180 * This function inserts where relevant so that multiple spaces are properly displayed in HTML
181 * even in the absence of <pre> (This is used in description to keep text formatting).
183 * @param string $text input text.
185 * @return string formatted text.
187 function space2nbsp($text)
189 return preg_replace('/(^| ) /m', '$1 ', $text);
193 * Format Shaarli's description
194 * TODO: Move me to ApplicationUtils when it's ready.
196 * @param string $description shaare's description.
197 * @param string $redirector if a redirector is set, use it to gerenate links.
199 * @return string formatted description.
201 function format_description($description, $redirector) {
202 return nl2br(space2nbsp(text2clickable($description, $redirector)));