]>
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())
100 $final_referer = '?';
102 // No referer if it contains any value in $loopCriteria.
103 foreach ($loopTerms as $value) {
104 if (strpos($referer, $value) !== false) {
105 return $final_referer;
109 // Remove port from HTTP_HOST
110 if ($pos = strpos($host, ':')) {
111 $host = substr($host, 0, $pos);
114 if (!empty($referer) && strpos(parse_url($referer, PHP_URL_HOST
), $host) !== false) {
115 $final_referer = $referer;
118 return $final_referer;
122 * Checks the PHP version to ensure Shaarli can run
124 * @param string $minVersion minimum PHP required version
125 * @param string $curVersion current PHP version (use PHP_VERSION)
127 * @throws Exception the PHP version is not supported
129 function checkPHPVersion($minVersion, $curVersion)
131 if (version_compare($curVersion, $minVersion) < 0) {
133 'Your PHP version is obsolete!'
134 .' Shaarli requires at least PHP '.$minVersion.', and thus cannot run.'
135 .' Your PHP version has known security vulnerabilities and should be'
136 .' updated as soon as possible.'