3 namespace Shaarli\Formatter
;
6 use Shaarli\Bookmark\Bookmark
;
7 use Shaarli\Config\ConfigManager
;
11 * Class BookmarkDefaultFormatterTest
12 * @package Shaarli\Formatter
14 class BookmarkDefaultFormatterTest
extends TestCase
16 /** @var string Path of test config file */
17 protected static $testConf = 'sandbox/config';
19 /** @var BookmarkFormatter */
22 /** @var ConfigManager instance */
26 * Initialize formatter instance.
28 protected function setUp(): void
30 copy('tests/utils/config/configJson.json.php', self
::$testConf .'.json.php');
31 $this->conf
= new ConfigManager(self
::$testConf);
32 $this->formatter
= new BookmarkDefaultFormatter($this->conf
, true);
36 * Test formatting a bookmark with all its attribute filled.
38 public function testFormatFull()
40 $bookmark = new Bookmark();
41 $bookmark->setId($id = 11);
42 $bookmark->setShortUrl($short = 'abcdef');
43 $bookmark->setUrl('https://sub.domain.tld?query=here&for=real#hash');
44 $bookmark->setTitle($title = 'This is a <strong>bookmark</strong>');
45 $bookmark->setDescription($desc = '<h2>Content</h2><p>`Here is some content</p>');
46 $bookmark->setTags($tags = ['tag1', 'bookmark', 'other', '<script>alert("xss");</script>']);
47 $bookmark->setThumbnail('http://domain2.tdl2/?type=img&name=file.png');
48 $bookmark->setSticky(true);
49 $bookmark->setCreated($created = DateTime
::createFromFormat('Ymd_His', '20190521_190412'));
50 $bookmark->setUpdated($updated = DateTime
::createFromFormat('Ymd_His', '20190521_191213'));
51 $bookmark->setPrivate(true);
53 $link = $this->formatter
->format($bookmark);
54 $this->assertEquals($id, $link['id']);
55 $this->assertEquals($short, $link['shorturl']);
56 $this->assertEquals('https://sub.domain.tld?query=here&for=real#hash', $link['url']);
58 'https://sub.domain.tld?query=here&for=real#hash',
61 $this->assertEquals('This is a <strong>bookmark</strong>', $link['title']);
63 '<h2>Content</h2><p>`Here is some content</p>',
66 $tags[3] = '<script>alert("xss");</script>';
67 $this->assertEquals($tags, $link['taglist']);
68 $this->assertEquals(implode(' ', $tags), $link['tags']);
70 'http://domain2.tdl2/?type=img&name=file.png',
73 $this->assertEquals($created, $link['created']);
74 $this->assertEquals($created->getTimestamp(), $link['timestamp']);
75 $this->assertEquals($updated, $link['updated']);
76 $this->assertEquals($updated->getTimestamp(), $link['updated_timestamp']);
77 $this->assertTrue($link['private']);
78 $this->assertTrue($link['sticky']);
79 $this->assertEquals('private', $link['class']);
83 * Test formatting a bookmark with all its attribute filled.
85 public function testFormatMinimal()
87 $bookmark = new Bookmark();
89 $link = $this->formatter
->format($bookmark);
90 $this->assertEmpty($link['id']);
91 $this->assertEmpty($link['shorturl']);
92 $this->assertEmpty($link['url']);
93 $this->assertEmpty($link['real_url']);
94 $this->assertEmpty($link['title']);
95 $this->assertEmpty($link['description']);
96 $this->assertEmpty($link['taglist']);
97 $this->assertEmpty($link['tags']);
98 $this->assertEmpty($link['thumbnail']);
99 $this->assertEmpty($link['created']);
100 $this->assertEmpty($link['timestamp']);
101 $this->assertEmpty($link['updated']);
102 $this->assertEmpty($link['updated_timestamp']);
103 $this->assertFalse($link['private']);
104 $this->assertFalse($link['sticky']);
105 $this->assertEmpty($link['class']);
109 * Make sure that the description is properly formatted by the default formatter.
111 public function testFormatDescription()
114 $description[] = 'This a <strong>description</strong>' . PHP_EOL
;
115 $description[] = 'text https://sub.domain.tld?query=here&for=real#hash more text'. PHP_EOL
;
116 $description[] = 'Also, there is an #hashtag added'. PHP_EOL
;
117 $description[] = ' A N D KEEP SPACES ! '. PHP_EOL
;
119 $bookmark = new Bookmark();
120 $bookmark->setDescription(implode('', $description));
121 $link = $this->formatter
->format($bookmark);
123 $description[0] = 'This a <strong>description</strong><br />';
124 $url = 'https://sub.domain.tld?query=here&for=real#hash';
125 $description[1] = 'text <a href="'. $url .'">'. $url .'</a> more text<br />';
126 $description[2] = 'Also, there is an <a href="./add-tag/hashtag" '.
127 'title="Hashtag hashtag">#hashtag</a> added<br />';
128 $description[3] = ' A N D KEEP '.
129 'SPACES ! <br />';
131 $this->assertEquals(implode(PHP_EOL
, $description) . PHP_EOL
, $link['description']);
135 * Test formatting URL with an index_url set
136 * It should prepend relative links.
138 public function testFormatNoteWithIndexUrl()
140 $bookmark = new Bookmark();
141 $bookmark->setUrl($short = '?abcdef');
142 $description = 'Text #hashtag more text';
143 $bookmark->setDescription($description);
145 $this->formatter
->addContextData('index_url', $root = 'https://domain.tld/hithere/');
147 $link = $this->formatter
->format($bookmark);
148 $this->assertEquals($root . $short, $link['url']);
149 $this->assertEquals($root . $short, $link['real_url']);
151 'Text <a href="'. $root .'./add-tag/hashtag" title="Hashtag hashtag">'.
152 '#hashtag</a> more text',
158 * Make sure that private tags are properly filtered out when the user is logged out.
160 public function testFormatTagListRemovePrivate(): void
162 $this->formatter
= new BookmarkDefaultFormatter($this->conf
, false);
164 $bookmark = new Bookmark();
165 $bookmark->setId($id = 11);
166 $bookmark->setTags($tags = ['bookmark', '.private', 'othertag']);
168 $link = $this->formatter
->format($bookmark);
171 $tags = array_values($tags);
173 $this->assertSame(11, $link['id']);
174 $this->assertSame($tags, $link['taglist']);
175 $this->assertSame(implode(' ', $tags), $link['tags']);
179 * Test formatTitleHtml with search result highlight.
181 public function testFormatTitleHtmlWithSearchHighlight(): void
183 $this->formatter
= new BookmarkDefaultFormatter($this->conf
, false);
185 $bookmark = new Bookmark();
186 $bookmark->setTitle('PSR-2: Coding Style Guide');
187 $bookmark->addAdditionalContentEntry(
190 ['start' => 0, 'end' => 5], // "psr-2"
191 ['start' => 7, 'end' => 13], // coding
192 ['start' => 20, 'end' => 25], // guide
196 $link = $this->formatter
->format($bookmark);
199 '<span class="search-highlight">PSR-2</span>: ' .
200 '<span class="search-highlight">Coding</span> Style ' .
201 '<span class="search-highlight">Guide</span>',
207 * Test formatDescription with search result highlight.
209 public function testFormatDescriptionWithSearchHighlight(): void
211 $this->formatter
= new BookmarkDefaultFormatter($this->conf
, false);
213 $bookmark = new Bookmark();
214 $bookmark->setDescription(
215 'This guide extends and expands on PSR-1, the basic coding standard.' . PHP_EOL
.
216 'https://www.php-fig.org/psr/psr-1/'
218 $bookmark->addAdditionalContentEntry(
221 ['start' => 0, 'end' => 10], // "This guide"
222 ['start' => 45, 'end' => 50], // basic
223 ['start' => 58, 'end' => 67], // standard.
224 ['start' => 84, 'end' => 87], // fig
228 $link = $this->formatter
->format($bookmark);
231 '<span class="search-highlight">This guide</span> extends and expands on PSR-1, the ' .
232 '<span class="search-highlight">basic</span> coding ' .
233 '<span class="search-highlight">standard.</span><br />' . PHP_EOL
.
234 '<a href="https://www.php-fig.org/psr/psr-1/">' .
235 'https://www.php-<span class="search-highlight">fig</span>.org/psr/psr-1/' .
242 * Test formatUrlHtml with search result highlight.
244 public function testFormatUrlHtmlWithSearchHighlight(): void
246 $this->formatter
= new BookmarkDefaultFormatter($this->conf
, false);
248 $bookmark = new Bookmark();
249 $bookmark->setUrl('http://www.php-fig.org/psr/psr-2/');
250 $bookmark->addAdditionalContentEntry(
253 ['start' => 0, 'end' => 4], // http
254 ['start' => 15, 'end' => 18], // fig
255 ['start' => 27, 'end' => 33], // "psr-2/"
259 $link = $this->formatter
->format($bookmark);
262 '<span class="search-highlight">http</span>://www.php-' .
263 '<span class="search-highlight">fig</span>.org/psr/' .
264 '<span class="search-highlight">psr-2/</span>',
270 * Test formatTagListHtml with search result highlight.
272 public function testFormatTagListHtmlWithSearchHighlight(): void
274 $this->formatter
= new BookmarkDefaultFormatter($this->conf
, false);
276 $bookmark = new Bookmark();
277 $bookmark->setTagsString('coding-style standards quality assurance');
278 $bookmark->addAdditionalContentEntry(
281 ['start' => 0, 'end' => 12], // coding-style
282 ['start' => 23, 'end' => 30], // quality
283 ['start' => 31, 'end' => 40], // assurance
287 $link = $this->formatter
->format($bookmark);
291 '<span class="search-highlight">coding-style</span>',
293 '<span class="search-highlight">quality</span>',
294 '<span class="search-highlight">assurance</span>',
296 $link['taglist_html']
301 * Test default formatting with formatter_settings.autolink set to false:
302 * URLs and hashtags should not be transformed
304 public function testFormatDescriptionWithoutLinkification(): void
306 $this->conf
->set('formatter_settings.autolink', false);
307 $this->formatter
= new BookmarkDefaultFormatter($this->conf
, false);
309 $bookmark = new Bookmark();
310 $bookmark->setDescription('Hi!' . PHP_EOL
. 'https://thisisaurl.tld #hashtag');
312 $link = $this->formatter
->format($bookmark);
315 'Hi!<br />' . PHP_EOL
. 'https://thisisaurl.tld #hashtag',