254 lines
7.5 KiB
PHP
254 lines
7.5 KiB
PHP
<?php
|
|
|
|
use Shaarli\Bookmark\Bookmark;
|
|
use Shaarli\Formatter\BookmarkDefaultFormatter;
|
|
|
|
/**
|
|
* Extract title from an HTML document.
|
|
*
|
|
* @param string $html HTML content where to look for a title.
|
|
*
|
|
* @return bool|string Extracted title if found, false otherwise.
|
|
*/
|
|
function html_extract_title($html)
|
|
{
|
|
if (preg_match('!<title.*?>(.*?)</title>!is', $html, $matches)) {
|
|
return trim(str_replace("\n", '', $matches[1]));
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Extract charset from HTTP header if it's defined.
|
|
*
|
|
* @param string $header HTTP header Content-Type line.
|
|
*
|
|
* @return bool|string Charset string if found (lowercase), false otherwise.
|
|
*/
|
|
function header_extract_charset($header)
|
|
{
|
|
preg_match('/charset=["\']?([^; "\']+)/i', $header, $match);
|
|
if (! empty($match[1])) {
|
|
return strtolower(trim($match[1]));
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Extract charset HTML content (tag <meta charset>).
|
|
*
|
|
* @param string $html HTML content where to look for charset.
|
|
*
|
|
* @return bool|string Charset string if found, false otherwise.
|
|
*/
|
|
function html_extract_charset($html)
|
|
{
|
|
// Get encoding specified in HTML header.
|
|
preg_match('#<meta .*charset=["\']?([^";\'>/]+)["\']? */?>#Usi', $html, $enc);
|
|
if (!empty($enc[1])) {
|
|
return strtolower($enc[1]);
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Extract meta tag from HTML content in either:
|
|
* - OpenGraph: <meta property="og:[tag]" ...>
|
|
* - Meta tag: <meta name="[tag]" ...>
|
|
*
|
|
* @param string $tag Name of the tag to retrieve.
|
|
* @param string $html HTML content where to look for charset.
|
|
*
|
|
* @return bool|string Charset string if found, false otherwise.
|
|
*/
|
|
function html_extract_tag($tag, $html)
|
|
{
|
|
$propertiesKey = ['property', 'name', 'itemprop'];
|
|
$properties = implode('|', $propertiesKey);
|
|
// We need a OR here to accept either 'property=og:noquote' or 'property="og:unrelated og:my-tag"'
|
|
$orCondition = '["\']?(?:og:)?' . $tag . '["\']?|["\'][^\'"]*?(?:og:)?' . $tag . '[^\'"]*?[\'"]';
|
|
// Support quotes in double quoted content, and the other way around
|
|
$content = 'content=(["\'])((?:(?!\1).)*)\1';
|
|
// Try to retrieve OpenGraph tag.
|
|
$ogRegex = '#<meta[^>]+(?:' . $properties . ')=(?:' . $orCondition . ')[^>]*' . $content . '.*?>#';
|
|
// If the attributes are not in the order property => content (e.g. Github)
|
|
// New regex to keep this readable... more or less.
|
|
$ogRegexReverse = '#<meta[^>]+' . $content . '[^>]+(?:' . $properties . ')=(?:' . $orCondition . ').*?>#';
|
|
|
|
if (
|
|
preg_match($ogRegex, $html, $matches) > 0
|
|
|| preg_match($ogRegexReverse, $html, $matches) > 0
|
|
) {
|
|
return $matches[2];
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* In a string, converts URLs to clickable bookmarks.
|
|
*
|
|
* @param string $text input string.
|
|
*
|
|
* @return string returns $text with all bookmarks converted to HTML bookmarks.
|
|
*
|
|
* @see Function inspired from http://www.php.net/manual/en/function.preg-replace.php#85722
|
|
*/
|
|
function text2clickable($text)
|
|
{
|
|
$regex = '!(((?:https?|ftp|file)://|apt:|magnet:)\S+[a-z0-9\(\)]/?)!si';
|
|
$format = function (array $match): string {
|
|
return '<a href="' .
|
|
str_replace(
|
|
BookmarkDefaultFormatter::SEARCH_HIGHLIGHT_OPEN,
|
|
'',
|
|
str_replace(BookmarkDefaultFormatter::SEARCH_HIGHLIGHT_CLOSE, '', $match[1])
|
|
) .
|
|
'">' . $match[1] . '</a>'
|
|
;
|
|
};
|
|
|
|
return preg_replace_callback($regex, $format, $text);
|
|
}
|
|
|
|
/**
|
|
* Auto-link hashtags.
|
|
*
|
|
* @param string $description Given description.
|
|
* @param string $indexUrl Root URL.
|
|
*
|
|
* @return string Description with auto-linked hashtags.
|
|
*/
|
|
function hashtag_autolink($description, $indexUrl = '')
|
|
{
|
|
$tokens = '(?:' . BookmarkDefaultFormatter::SEARCH_HIGHLIGHT_OPEN . ')' .
|
|
'(?:' . BookmarkDefaultFormatter::SEARCH_HIGHLIGHT_CLOSE . ')'
|
|
;
|
|
/*
|
|
* To support unicode: http://stackoverflow.com/a/35498078/1484919
|
|
* \p{Pc} - to match underscore
|
|
* \p{N} - numeric character in any script
|
|
* \p{L} - letter from any language
|
|
* \p{Mn} - any non marking space (accents, umlauts, etc)
|
|
*/
|
|
$regex = '/(^|\s)#([\p{Pc}\p{N}\p{L}\p{Mn}' . $tokens . ']+)/mui';
|
|
$format = function (array $match) use ($indexUrl): string {
|
|
$cleanMatch = str_replace(
|
|
BookmarkDefaultFormatter::SEARCH_HIGHLIGHT_OPEN,
|
|
'',
|
|
str_replace(BookmarkDefaultFormatter::SEARCH_HIGHLIGHT_CLOSE, '', $match[2])
|
|
);
|
|
return $match[1] . '<a href="' . $indexUrl . './add-tag/' . $cleanMatch . '"' .
|
|
' title="Hashtag ' . $cleanMatch . '">' .
|
|
'#' . $match[2] .
|
|
'</a>';
|
|
};
|
|
|
|
return preg_replace_callback($regex, $format, $description);
|
|
}
|
|
|
|
/**
|
|
* 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).
|
|
*
|
|
* @param string $text input text.
|
|
*
|
|
* @return string formatted text.
|
|
*/
|
|
function space2nbsp($text)
|
|
{
|
|
return preg_replace('/(^| ) /m', '$1 ', $text);
|
|
}
|
|
|
|
/**
|
|
* Format Shaarli's description
|
|
*
|
|
* @param string $description shaare's description.
|
|
* @param string $indexUrl URL to Shaarli's index.
|
|
* @param bool $autolink Turn on/off automatic linkifications of URLs and hashtags
|
|
*
|
|
* @return string formatted description.
|
|
*/
|
|
function format_description($description, $indexUrl = '', $autolink = true)
|
|
{
|
|
if ($autolink) {
|
|
$description = hashtag_autolink(text2clickable($description), $indexUrl);
|
|
}
|
|
|
|
return nl2br(space2nbsp($description));
|
|
}
|
|
|
|
/**
|
|
* Generate a small hash for a link.
|
|
*
|
|
* @param DateTime $date Link creation date.
|
|
* @param int $id Link ID.
|
|
*
|
|
* @return string the small hash generated from link data.
|
|
*/
|
|
function link_small_hash($date, $id)
|
|
{
|
|
return smallHash($date->format(Bookmark::LINK_DATE_FORMAT) . $id);
|
|
}
|
|
|
|
/**
|
|
* Returns whether or not the link is an internal note.
|
|
* Its URL starts by `?` because it's actually a permalink.
|
|
*
|
|
* @param string $linkUrl
|
|
*
|
|
* @return bool true if internal note, false otherwise.
|
|
*/
|
|
function is_note($linkUrl)
|
|
{
|
|
return isset($linkUrl[0]) && $linkUrl[0] === '?';
|
|
}
|
|
|
|
/**
|
|
* Extract an array of tags from a given tag string, with provided separator.
|
|
*
|
|
* @param string|null $tags String containing a list of tags separated by $separator.
|
|
* @param string $separator Shaarli's default: ' ' (whitespace)
|
|
*
|
|
* @return array List of tags
|
|
*/
|
|
function tags_str2array(?string $tags, string $separator): array
|
|
{
|
|
// For whitespaces, we use the special \s regex character
|
|
$separator = str_replace([' ', '/'], ['\s', '\/'], $separator);
|
|
|
|
return preg_split('/\s*' . $separator . '+\s*/', trim($tags ?? ''), -1, PREG_SPLIT_NO_EMPTY) ?: [];
|
|
}
|
|
|
|
/**
|
|
* Return a tag string with provided separator from a list of tags.
|
|
* Note that given array is clean up by tags_filter().
|
|
*
|
|
* @param array|null $tags List of tags
|
|
* @param string $separator
|
|
*
|
|
* @return string
|
|
*/
|
|
function tags_array2str(?array $tags, string $separator): string
|
|
{
|
|
return implode($separator, tags_filter($tags, $separator));
|
|
}
|
|
|
|
/**
|
|
* Clean an array of tags: trim + remove empty entries
|
|
*
|
|
* @param array|null $tags List of tags
|
|
* @param string $separator
|
|
*
|
|
* @return array
|
|
*/
|
|
function tags_filter(?array $tags, string $separator): array
|
|
{
|
|
$trimDefault = " \t\n\r\0\x0B";
|
|
return array_values(array_filter(array_map(function (string $entry) use ($separator, $trimDefault): string {
|
|
return trim($entry, $trimDefault . $separator);
|
|
}, $tags ?? [])));
|
|
}
|