2cd0509b50
Also added a bunch of tests to cover more use cases. Fixes #1375
584 lines
21 KiB
PHP
584 lines
21 KiB
PHP
<?php
|
|
|
|
namespace Shaarli\Bookmark;
|
|
|
|
use PHPUnit\Framework\TestCase;
|
|
|
|
require_once 'tests/utils/CurlUtils.php';
|
|
|
|
/**
|
|
* Class LinkUtilsTest.
|
|
*/
|
|
class LinkUtilsTest extends TestCase
|
|
{
|
|
/**
|
|
* Test html_extract_title() when the title is found.
|
|
*/
|
|
public function testHtmlExtractExistentTitle()
|
|
{
|
|
$title = 'Read me please.';
|
|
$html = '<html><meta>stuff</meta><title>' . $title . '</title></html>';
|
|
$this->assertEquals($title, html_extract_title($html));
|
|
$html = '<html><title>' . $title . '</title>blabla<title>another</title></html>';
|
|
$this->assertEquals($title, html_extract_title($html));
|
|
}
|
|
|
|
/**
|
|
* Test html_extract_title() when the title is not found.
|
|
*/
|
|
public function testHtmlExtractNonExistentTitle()
|
|
{
|
|
$html = '<html><meta>stuff</meta></html>';
|
|
$this->assertFalse(html_extract_title($html));
|
|
}
|
|
|
|
/**
|
|
* Test headers_extract_charset() when the charset is found.
|
|
*/
|
|
public function testHeadersExtractExistentCharset()
|
|
{
|
|
$charset = 'x-MacCroatian';
|
|
$headers = 'text/html; charset=' . $charset;
|
|
$this->assertEquals(strtolower($charset), header_extract_charset($headers));
|
|
}
|
|
|
|
/**
|
|
* Test headers_extract_charset() when the charset is not found.
|
|
*/
|
|
public function testHeadersExtractNonExistentCharset()
|
|
{
|
|
$headers = '';
|
|
$this->assertFalse(header_extract_charset($headers));
|
|
|
|
$headers = 'text/html';
|
|
$this->assertFalse(header_extract_charset($headers));
|
|
}
|
|
|
|
/**
|
|
* Test html_extract_charset() when the charset is found.
|
|
*/
|
|
public function testHtmlExtractExistentCharset()
|
|
{
|
|
$charset = 'x-MacCroatian';
|
|
$html = '<html><meta>stuff2</meta><meta charset="' . $charset . '"/></html>';
|
|
$this->assertEquals(strtolower($charset), html_extract_charset($html));
|
|
}
|
|
|
|
/**
|
|
* Test html_extract_charset() when the charset is not found.
|
|
*/
|
|
public function testHtmlExtractNonExistentCharset()
|
|
{
|
|
$html = '<html><meta>stuff</meta></html>';
|
|
$this->assertFalse(html_extract_charset($html));
|
|
$html = '<html><meta>stuff</meta><meta charset=""/></html>';
|
|
$this->assertFalse(html_extract_charset($html));
|
|
}
|
|
|
|
/**
|
|
* Test html_extract_tag() when the tag <meta name= is found.
|
|
*/
|
|
public function testHtmlExtractExistentNameTag()
|
|
{
|
|
$description = 'Bob and Alice share cookies.';
|
|
|
|
// Simple one line
|
|
$html = '<html><meta>stuff2</meta><meta name="description" content="' . $description . '"/></html>';
|
|
$this->assertEquals($description, html_extract_tag('description', $html));
|
|
|
|
// Simple OpenGraph
|
|
$html = '<meta property="og:description" content="' . $description . '">';
|
|
$this->assertEquals($description, html_extract_tag('description', $html));
|
|
|
|
// Simple reversed OpenGraph
|
|
$html = '<meta content="' . $description . '" property="og:description">';
|
|
$this->assertEquals($description, html_extract_tag('description', $html));
|
|
|
|
// ItemProp OpenGraph
|
|
$html = '<meta itemprop="og:description" content="' . $description . '">';
|
|
$this->assertEquals($description, html_extract_tag('description', $html));
|
|
|
|
// OpenGraph without quotes
|
|
$html = '<meta property=og:description content="' . $description . '">';
|
|
$this->assertEquals($description, html_extract_tag('description', $html));
|
|
|
|
// OpenGraph reversed without quotes
|
|
$html = '<meta content="' . $description . '" property=og:description>';
|
|
$this->assertEquals($description, html_extract_tag('description', $html));
|
|
|
|
// OpenGraph with noise
|
|
$html = '<meta tag1="content1" property="og:description" tag2="content2" content="' .
|
|
$description . '" tag3="content3">';
|
|
$this->assertEquals($description, html_extract_tag('description', $html));
|
|
|
|
// OpenGraph reversed with noise
|
|
$html = '<meta tag1="content1" content="' . $description . '" ' .
|
|
'tag3="content3" tag2="content2" property="og:description">';
|
|
$this->assertEquals($description, html_extract_tag('description', $html));
|
|
|
|
// OpenGraph multiple properties start
|
|
$html = '<meta property="unrelated og:description" content="' . $description . '">';
|
|
$this->assertEquals($description, html_extract_tag('description', $html));
|
|
|
|
// OpenGraph multiple properties end
|
|
$html = '<meta property="og:description unrelated" content="' . $description . '">';
|
|
$this->assertEquals($description, html_extract_tag('description', $html));
|
|
|
|
// OpenGraph multiple properties both end
|
|
$html = '<meta property="og:unrelated1 og:description og:unrelated2" content="' . $description . '">';
|
|
$this->assertEquals($description, html_extract_tag('description', $html));
|
|
|
|
// OpenGraph multiple properties both end with noise
|
|
$html = '<meta tag1="content1" property="og:unrelated1 og:description og:unrelated2" '.
|
|
'tag2="content2" content="' . $description . '" tag3="content3">';
|
|
$this->assertEquals($description, html_extract_tag('description', $html));
|
|
|
|
// OpenGraph reversed multiple properties start
|
|
$html = '<meta content="' . $description . '" property="unrelated og:description">';
|
|
$this->assertEquals($description, html_extract_tag('description', $html));
|
|
|
|
// OpenGraph reversed multiple properties end
|
|
$html = '<meta content="' . $description . '" property="og:description unrelated">';
|
|
$this->assertEquals($description, html_extract_tag('description', $html));
|
|
|
|
// OpenGraph reversed multiple properties both end
|
|
$html = '<meta content="' . $description . '" property="og:unrelated1 og:description og:unrelated2">';
|
|
$this->assertEquals($description, html_extract_tag('description', $html));
|
|
|
|
// OpenGraph reversed multiple properties both end with noise
|
|
$html = '<meta tag1="content1" content="' . $description . '" tag2="content2" '.
|
|
'property="og:unrelated1 og:description og:unrelated2" tag3="content3">';
|
|
$this->assertEquals($description, html_extract_tag('description', $html));
|
|
|
|
// Suggestion from #1375
|
|
$html = '<meta property="og:description" name="description" content="' . $description . '">';
|
|
$this->assertEquals($description, html_extract_tag('description', $html));
|
|
}
|
|
|
|
/**
|
|
* Test html_extract_tag() when the tag <meta name= is not found.
|
|
*/
|
|
public function testHtmlExtractNonExistentNameTag()
|
|
{
|
|
$html = '<html><meta>stuff2</meta><meta name="image" content="img"/></html>';
|
|
$this->assertFalse(html_extract_tag('description', $html));
|
|
|
|
// Partial meta tag
|
|
$html = '<meta content="Brief description">';
|
|
$this->assertFalse(html_extract_tag('description', $html));
|
|
|
|
$html = '<meta property="og:description">';
|
|
$this->assertFalse(html_extract_tag('description', $html));
|
|
|
|
$html = '<meta tag1="content1" property="og:description">';
|
|
$this->assertFalse(html_extract_tag('description', $html));
|
|
|
|
$html = '<meta property="og:description" tag1="content1">';
|
|
$this->assertFalse(html_extract_tag('description', $html));
|
|
|
|
$html = '<meta tag1="content1" content="Brief description">';
|
|
$this->assertFalse(html_extract_tag('description', $html));
|
|
|
|
$html = '<meta content="Brief description" tag1="content1">';
|
|
$this->assertFalse(html_extract_tag('description', $html));
|
|
}
|
|
|
|
/**
|
|
* Test html_extract_tag() when the tag <meta property="og: is found.
|
|
*/
|
|
public function testHtmlExtractExistentOgTag()
|
|
{
|
|
$description = 'Bob and Alice share cookies.';
|
|
$html = '<html><meta>stuff2</meta><meta property="og:description" content="' . $description . '"/></html>';
|
|
$this->assertEquals($description, html_extract_tag('description', $html));
|
|
}
|
|
|
|
/**
|
|
* Test html_extract_tag() when the tag <meta property="og: is not found.
|
|
*/
|
|
public function testHtmlExtractNonExistentOgTag()
|
|
{
|
|
$html = '<html><meta>stuff2</meta><meta name="image" content="img"/></html>';
|
|
$this->assertFalse(html_extract_tag('description', $html));
|
|
}
|
|
|
|
/**
|
|
* Test the download callback with valid value
|
|
*/
|
|
public function testCurlDownloadCallbackOk()
|
|
{
|
|
$callback = get_curl_download_callback(
|
|
$charset,
|
|
$title,
|
|
$desc,
|
|
$keywords,
|
|
false,
|
|
'ut_curl_getinfo_ok'
|
|
);
|
|
$data = [
|
|
'HTTP/1.1 200 OK',
|
|
'Server: GitHub.com',
|
|
'Date: Sat, 28 Oct 2017 12:01:33 GMT',
|
|
'Content-Type: text/html; charset=utf-8',
|
|
'Status: 200 OK',
|
|
'end' => 'th=device-width">'
|
|
. '<title>Refactoring · GitHub</title>'
|
|
. '<link rel="search" type="application/opensea',
|
|
'<title>ignored</title>'
|
|
. '<meta name="description" content="desc" />'
|
|
. '<meta name="keywords" content="key1,key2" />',
|
|
];
|
|
foreach ($data as $key => $line) {
|
|
$ignore = null;
|
|
$expected = $key !== 'end' ? strlen($line) : false;
|
|
$this->assertEquals($expected, $callback($ignore, $line));
|
|
if ($expected === false) {
|
|
break;
|
|
}
|
|
}
|
|
$this->assertEquals('utf-8', $charset);
|
|
$this->assertEquals('Refactoring · GitHub', $title);
|
|
$this->assertEmpty($desc);
|
|
$this->assertEmpty($keywords);
|
|
}
|
|
|
|
/**
|
|
* Test the download callback with valid values and no charset
|
|
*/
|
|
public function testCurlDownloadCallbackOkNoCharset()
|
|
{
|
|
$callback = get_curl_download_callback(
|
|
$charset,
|
|
$title,
|
|
$desc,
|
|
$keywords,
|
|
false,
|
|
'ut_curl_getinfo_no_charset'
|
|
);
|
|
$data = [
|
|
'HTTP/1.1 200 OK',
|
|
'end' => 'th=device-width">'
|
|
. '<title>Refactoring · GitHub</title>'
|
|
. '<link rel="search" type="application/opensea',
|
|
'<title>ignored</title>'
|
|
. '<meta name="description" content="desc" />'
|
|
. '<meta name="keywords" content="key1,key2" />',
|
|
];
|
|
foreach ($data as $key => $line) {
|
|
$ignore = null;
|
|
$this->assertEquals(strlen($line), $callback($ignore, $line));
|
|
}
|
|
$this->assertEmpty($charset);
|
|
$this->assertEquals('Refactoring · GitHub', $title);
|
|
$this->assertEmpty($desc);
|
|
$this->assertEmpty($keywords);
|
|
}
|
|
|
|
/**
|
|
* Test the download callback with valid values and no charset
|
|
*/
|
|
public function testCurlDownloadCallbackOkHtmlCharset()
|
|
{
|
|
$callback = get_curl_download_callback(
|
|
$charset,
|
|
$title,
|
|
$desc,
|
|
$keywords,
|
|
false,
|
|
'ut_curl_getinfo_no_charset'
|
|
);
|
|
$data = [
|
|
'HTTP/1.1 200 OK',
|
|
'<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />',
|
|
'end' => 'th=device-width">'
|
|
. '<title>Refactoring · GitHub</title>'
|
|
. '<link rel="search" type="application/opensea',
|
|
'<title>ignored</title>'
|
|
. '<meta name="description" content="desc" />'
|
|
. '<meta name="keywords" content="key1,key2" />',
|
|
];
|
|
foreach ($data as $key => $line) {
|
|
$ignore = null;
|
|
$expected = $key !== 'end' ? strlen($line) : false;
|
|
$this->assertEquals($expected, $callback($ignore, $line));
|
|
if ($expected === false) {
|
|
break;
|
|
}
|
|
}
|
|
$this->assertEquals('utf-8', $charset);
|
|
$this->assertEquals('Refactoring · GitHub', $title);
|
|
$this->assertEmpty($desc);
|
|
$this->assertEmpty($keywords);
|
|
}
|
|
|
|
/**
|
|
* Test the download callback with valid values and no title
|
|
*/
|
|
public function testCurlDownloadCallbackOkNoTitle()
|
|
{
|
|
$callback = get_curl_download_callback(
|
|
$charset,
|
|
$title,
|
|
$desc,
|
|
$keywords,
|
|
false,
|
|
'ut_curl_getinfo_ok'
|
|
);
|
|
$data = [
|
|
'HTTP/1.1 200 OK',
|
|
'end' => 'th=device-width">Refactoring · GitHub<link rel="search" type="application/opensea',
|
|
'ignored',
|
|
];
|
|
foreach ($data as $key => $line) {
|
|
$ignore = null;
|
|
$this->assertEquals(strlen($line), $callback($ignore, $line));
|
|
}
|
|
$this->assertEquals('utf-8', $charset);
|
|
$this->assertEmpty($title);
|
|
$this->assertEmpty($desc);
|
|
$this->assertEmpty($keywords);
|
|
}
|
|
|
|
/**
|
|
* Test the download callback with an invalid content type.
|
|
*/
|
|
public function testCurlDownloadCallbackInvalidContentType()
|
|
{
|
|
$callback = get_curl_download_callback(
|
|
$charset,
|
|
$title,
|
|
$desc,
|
|
$keywords,
|
|
false,
|
|
'ut_curl_getinfo_ct_ko'
|
|
);
|
|
$ignore = null;
|
|
$this->assertFalse($callback($ignore, ''));
|
|
$this->assertEmpty($charset);
|
|
$this->assertEmpty($title);
|
|
}
|
|
|
|
/**
|
|
* Test the download callback with an invalid response code.
|
|
*/
|
|
public function testCurlDownloadCallbackInvalidResponseCode()
|
|
{
|
|
$callback = $callback = get_curl_download_callback(
|
|
$charset,
|
|
$title,
|
|
$desc,
|
|
$keywords,
|
|
false,
|
|
'ut_curl_getinfo_rc_ko'
|
|
);
|
|
$ignore = null;
|
|
$this->assertFalse($callback($ignore, ''));
|
|
$this->assertEmpty($charset);
|
|
$this->assertEmpty($title);
|
|
}
|
|
|
|
/**
|
|
* Test the download callback with an invalid content type and response code.
|
|
*/
|
|
public function testCurlDownloadCallbackInvalidContentTypeAndResponseCode()
|
|
{
|
|
$callback = $callback = get_curl_download_callback(
|
|
$charset,
|
|
$title,
|
|
$desc,
|
|
$keywords,
|
|
false,
|
|
'ut_curl_getinfo_rs_ct_ko'
|
|
);
|
|
$ignore = null;
|
|
$this->assertFalse($callback($ignore, ''));
|
|
$this->assertEmpty($charset);
|
|
$this->assertEmpty($title);
|
|
}
|
|
|
|
/**
|
|
* Test the download callback with valid value, and retrieve_description option enabled.
|
|
*/
|
|
public function testCurlDownloadCallbackOkWithDesc()
|
|
{
|
|
$callback = get_curl_download_callback(
|
|
$charset,
|
|
$title,
|
|
$desc,
|
|
$keywords,
|
|
true,
|
|
'ut_curl_getinfo_ok'
|
|
);
|
|
$data = [
|
|
'HTTP/1.1 200 OK',
|
|
'Server: GitHub.com',
|
|
'Date: Sat, 28 Oct 2017 12:01:33 GMT',
|
|
'Content-Type: text/html; charset=utf-8',
|
|
'Status: 200 OK',
|
|
'th=device-width">'
|
|
. '<title>Refactoring · GitHub</title>'
|
|
. '<link rel="search" type="application/opensea',
|
|
'end' => '<title>ignored</title>'
|
|
. '<meta name="description" content="link desc" />'
|
|
. '<meta name="keywords" content="key1,key2" />',
|
|
];
|
|
foreach ($data as $key => $line) {
|
|
$ignore = null;
|
|
$expected = $key !== 'end' ? strlen($line) : false;
|
|
$this->assertEquals($expected, $callback($ignore, $line));
|
|
if ($expected === false) {
|
|
break;
|
|
}
|
|
}
|
|
$this->assertEquals('utf-8', $charset);
|
|
$this->assertEquals('Refactoring · GitHub', $title);
|
|
$this->assertEquals('link desc', $desc);
|
|
$this->assertEquals('key1 key2', $keywords);
|
|
}
|
|
|
|
/**
|
|
* Test the download callback with valid value, and retrieve_description option enabled,
|
|
* but no desc or keyword defined in the page.
|
|
*/
|
|
public function testCurlDownloadCallbackOkWithDescNotFound()
|
|
{
|
|
$callback = get_curl_download_callback(
|
|
$charset,
|
|
$title,
|
|
$desc,
|
|
$keywords,
|
|
true,
|
|
'ut_curl_getinfo_ok'
|
|
);
|
|
$data = [
|
|
'HTTP/1.1 200 OK',
|
|
'Server: GitHub.com',
|
|
'Date: Sat, 28 Oct 2017 12:01:33 GMT',
|
|
'Content-Type: text/html; charset=utf-8',
|
|
'Status: 200 OK',
|
|
'th=device-width">'
|
|
. '<title>Refactoring · GitHub</title>'
|
|
. '<link rel="search" type="application/opensea',
|
|
'end' => '<title>ignored</title>',
|
|
];
|
|
foreach ($data as $key => $line) {
|
|
$ignore = null;
|
|
$expected = $key !== 'end' ? strlen($line) : false;
|
|
$this->assertEquals($expected, $callback($ignore, $line));
|
|
if ($expected === false) {
|
|
break;
|
|
}
|
|
}
|
|
$this->assertEquals('utf-8', $charset);
|
|
$this->assertEquals('Refactoring · GitHub', $title);
|
|
$this->assertEmpty($desc);
|
|
$this->assertEmpty($keywords);
|
|
}
|
|
|
|
/**
|
|
* Test text2clickable.
|
|
*/
|
|
public function testText2clickable()
|
|
{
|
|
$text = 'stuff http://hello.there/is=someone#here otherstuff';
|
|
$expectedText = 'stuff <a href="http://hello.there/is=someone#here">'
|
|
. 'http://hello.there/is=someone#here</a> otherstuff';
|
|
$processedText = text2clickable($text);
|
|
$this->assertEquals($expectedText, $processedText);
|
|
|
|
$text = 'stuff http://hello.there/is=someone#here(please) otherstuff';
|
|
$expectedText = 'stuff <a href="http://hello.there/is=someone#here(please)">'
|
|
. 'http://hello.there/is=someone#here(please)</a> otherstuff';
|
|
$processedText = text2clickable($text);
|
|
$this->assertEquals($expectedText, $processedText);
|
|
|
|
$text = 'stuff http://hello.there/is=someone#here(please)&no otherstuff';
|
|
$text = 'stuff http://hello.there/is=someone#here(please)&no otherstuff';
|
|
$expectedText = 'stuff <a href="http://hello.there/is=someone#here(please)&no">'
|
|
. 'http://hello.there/is=someone#here(please)&no</a> otherstuff';
|
|
$processedText = text2clickable($text);
|
|
$this->assertEquals($expectedText, $processedText);
|
|
}
|
|
|
|
/**
|
|
* Test testSpace2nbsp.
|
|
*/
|
|
public function testSpace2nbsp()
|
|
{
|
|
$text = ' Are you thrilled by flags ?' . PHP_EOL . ' Really?';
|
|
$expectedText = ' Are you thrilled by flags ?' . PHP_EOL . ' Really?';
|
|
$processedText = space2nbsp($text);
|
|
$this->assertEquals($expectedText, $processedText);
|
|
}
|
|
|
|
/**
|
|
* Test hashtags auto-link.
|
|
*/
|
|
public function testHashtagAutolink()
|
|
{
|
|
$index = 'http://domain.tld/';
|
|
$rawDescription = '#hashtag\n
|
|
# nothashtag\n
|
|
test#nothashtag #hashtag \#nothashtag\n
|
|
test #hashtag #hashtag test #hashtag.test\n
|
|
#hashtag #hashtag-nothashtag #hashtag_hashtag\n
|
|
What is #ашок anyway?\n
|
|
カタカナ #カタカナ」カタカナ\n';
|
|
$autolinkedDescription = hashtag_autolink($rawDescription, $index);
|
|
|
|
$this->assertContains($this->getHashtagLink('hashtag', $index), $autolinkedDescription);
|
|
$this->assertNotContains(' #hashtag', $autolinkedDescription);
|
|
$this->assertNotContains('>#nothashtag', $autolinkedDescription);
|
|
$this->assertContains($this->getHashtagLink('ашок', $index), $autolinkedDescription);
|
|
$this->assertContains($this->getHashtagLink('カタカナ', $index), $autolinkedDescription);
|
|
$this->assertContains($this->getHashtagLink('hashtag_hashtag', $index), $autolinkedDescription);
|
|
$this->assertNotContains($this->getHashtagLink('hashtag-nothashtag', $index), $autolinkedDescription);
|
|
}
|
|
|
|
/**
|
|
* Test hashtags auto-link without index URL.
|
|
*/
|
|
public function testHashtagAutolinkNoIndex()
|
|
{
|
|
$rawDescription = 'blabla #hashtag x#nothashtag';
|
|
$autolinkedDescription = hashtag_autolink($rawDescription);
|
|
|
|
$this->assertContains($this->getHashtagLink('hashtag'), $autolinkedDescription);
|
|
$this->assertNotContains(' #hashtag', $autolinkedDescription);
|
|
$this->assertNotContains('>#nothashtag', $autolinkedDescription);
|
|
}
|
|
|
|
/**
|
|
* Test is_note with note URLs.
|
|
*/
|
|
public function testIsNote()
|
|
{
|
|
$this->assertTrue(is_note('?'));
|
|
$this->assertTrue(is_note('?abcDEf'));
|
|
$this->assertTrue(is_note('?_abcDEf#123'));
|
|
}
|
|
|
|
/**
|
|
* Test is_note with non note URLs.
|
|
*/
|
|
public function testIsNotNote()
|
|
{
|
|
$this->assertFalse(is_note(''));
|
|
$this->assertFalse(is_note('nope'));
|
|
$this->assertFalse(is_note('https://github.com/shaarli/Shaarli/?hi'));
|
|
}
|
|
|
|
/**
|
|
* Util function to build an hashtag link.
|
|
*
|
|
* @param string $hashtag Hashtag name.
|
|
* @param string $index Index URL.
|
|
*
|
|
* @return string HTML hashtag link.
|
|
*/
|
|
private function getHashtagLink($hashtag, $index = '')
|
|
{
|
|
$hashtagLink = '<a href="' . $index . './add-tag/$1" title="Hashtag $1">#$1</a>';
|
|
return str_replace('$1', $hashtag, $hashtagLink);
|
|
}
|
|
}
|