From 520d29578c57e476ece3bdd20c286d196b7b61b4 Mon Sep 17 00:00:00 2001 From: ArthurHoaro Date: Sat, 9 Feb 2019 13:52:12 +0100 Subject: [PATCH] Remove the redirector setting Fixes #1239 --- application/api/ApiMiddleware.php | 4 +-- application/bookmark/LinkDB.php | 41 ++++------------------------ application/bookmark/LinkUtils.php | 24 +++------------- application/config/ConfigManager.php | 4 --- application/feed/FeedBuilder.php | 2 +- application/updater/Updater.php | 11 +++++++- doc/md/Shaarli-configuration.md | 11 -------- index.php | 27 ++++-------------- tests/bookmark/LinkDBTest.php | 32 +--------------------- tests/bookmark/LinkUtilsTest.php | 41 ++++------------------------ tests/plugins/PluginMarkdownTest.php | 2 +- tests/updater/UpdaterTest.php | 19 ++++++++++--- 12 files changed, 50 insertions(+), 168 deletions(-) diff --git a/application/api/ApiMiddleware.php b/application/api/ApiMiddleware.php index 5ffb8c6d..2d55bda6 100644 --- a/application/api/ApiMiddleware.php +++ b/application/api/ApiMiddleware.php @@ -129,9 +129,7 @@ class ApiMiddleware $linkDb = new \Shaarli\Bookmark\LinkDB( $conf->get('resource.datastore'), true, - $conf->get('privacy.hide_public_links'), - $conf->get('redirector.url'), - $conf->get('redirector.encode_url') + $conf->get('privacy.hide_public_links') ); $this->container['db'] = $linkDb; } diff --git a/application/bookmark/LinkDB.php b/application/bookmark/LinkDB.php index c13a1141..266632e3 100644 --- a/application/bookmark/LinkDB.php +++ b/application/bookmark/LinkDB.php @@ -29,10 +29,10 @@ use Shaarli\FileUtils; * - private: Is this link private? 0=no, other value=yes * - tags: tags attached to this entry (separated by spaces) * - title Title of the link - * - url URL of the link. Used for displayable links (no redirector, relative, etc.). - * Can be absolute or relative. - * Relative URLs are permalinks (e.g.'?m-ukcw') - * - real_url Absolute processed URL. + * - url URL of the link. Used for displayable links. + * Can be absolute or relative in the database but the relative links + * will be converted to absolute ones in templates. + * - real_url Raw URL in stored in the DB (absolute or relative). * - shorturl Permalink smallhash * * Implements 3 interfaces: @@ -88,19 +88,6 @@ class LinkDB implements Iterator, Countable, ArrayAccess // Hide public links private $hidePublicLinks; - // link redirector set in user settings. - private $redirector; - - /** - * Set this to `true` to urlencode link behind redirector link, `false` to leave it untouched. - * - * Example: - * anonym.to needs clean URL while dereferer.org needs urlencoded URL. - * - * @var boolean $redirectorEncode parameter: true or false - */ - private $redirectorEncode; - /** * Creates a new LinkDB * @@ -109,22 +96,16 @@ class LinkDB implements Iterator, Countable, ArrayAccess * @param string $datastore datastore file path. * @param boolean $isLoggedIn is the user logged in? * @param boolean $hidePublicLinks if true all links are private. - * @param string $redirector link redirector set in user settings. - * @param boolean $redirectorEncode Enable urlencode on redirected urls (default: true). */ public function __construct( $datastore, $isLoggedIn, - $hidePublicLinks, - $redirector = '', - $redirectorEncode = true + $hidePublicLinks ) { $this->datastore = $datastore; $this->loggedIn = $isLoggedIn; $this->hidePublicLinks = $hidePublicLinks; - $this->redirector = $redirector; - $this->redirectorEncode = $redirectorEncode === true; $this->check(); $this->read(); } @@ -323,17 +304,7 @@ You use the community supported version of the original Shaarli project, by Seba $link['tags'] = preg_replace('/(^|\s+)\.[^($|\s)]+\s*/', ' ', $link['tags']); } - // Do not use the redirector for internal links (Shaarli note URL starting with a '?'). - if (!empty($this->redirector) && !startsWith($link['url'], '?')) { - $link['real_url'] = $this->redirector; - if ($this->redirectorEncode) { - $link['real_url'] .= urlencode(unescape($link['url'])); - } else { - $link['real_url'] .= $link['url']; - } - } else { - $link['real_url'] = $link['url']; - } + $link['real_url'] = $link['url']; // To be able to load links before running the update, and prepare the update if (!isset($link['created'])) { diff --git a/application/bookmark/LinkUtils.php b/application/bookmark/LinkUtils.php index de5b61cb..988970bd 100644 --- a/application/bookmark/LinkUtils.php +++ b/application/bookmark/LinkUtils.php @@ -133,29 +133,15 @@ function count_private($links) * In a string, converts URLs to clickable links. * * @param string $text input string. - * @param string $redirector if a redirector is set, use it to gerenate links. - * @param bool $urlEncode Use `urlencode()` on the URL after the redirector or not. * * @return string returns $text with all links converted to HTML links. * * @see Function inspired from http://www.php.net/manual/en/function.preg-replace.php#85722 */ -function text2clickable($text, $redirector = '', $urlEncode = true) +function text2clickable($text) { $regex = '!(((?:https?|ftp|file)://|apt:|magnet:)\S+[a-z0-9\(\)]/?)!si'; - - if (empty($redirector)) { - return preg_replace($regex, '$1', $text); - } - // Redirector is set, urlencode the final URL. - return preg_replace_callback( - $regex, - function ($matches) use ($redirector, $urlEncode) { - $url = $urlEncode ? urlencode($matches[1]) : $matches[1]; - return ''. $matches[1] .''; - }, - $text - ); + return preg_replace($regex, '$1', $text); } /** @@ -197,15 +183,13 @@ function space2nbsp($text) * Format Shaarli's description * * @param string $description shaare's description. - * @param string $redirector if a redirector is set, use it to gerenate links. - * @param bool $urlEncode Use `urlencode()` on the URL after the redirector or not. * @param string $indexUrl URL to Shaarli's index. * @return string formatted description. */ -function format_description($description, $redirector = '', $urlEncode = true, $indexUrl = '') +function format_description($description, $indexUrl = '') { - return nl2br(space2nbsp(hashtag_autolink(text2clickable($description, $redirector, $urlEncode), $indexUrl))); + return nl2br(space2nbsp(hashtag_autolink(text2clickable($description), $indexUrl))); } /** diff --git a/application/config/ConfigManager.php b/application/config/ConfigManager.php index e6c35073..30993928 100644 --- a/application/config/ConfigManager.php +++ b/application/config/ConfigManager.php @@ -221,7 +221,6 @@ class ConfigManager 'general.title', 'general.header_link', 'privacy.default_private_links', - 'redirector.url', ); // Only logged in user can alter config. @@ -381,9 +380,6 @@ class ConfigManager // default state of the 'remember me' checkbox of the login form $this->setEmpty('privacy.remember_user_default', true); - $this->setEmpty('redirector.url', ''); - $this->setEmpty('redirector.encode_url', true); - $this->setEmpty('thumbnails.width', '125'); $this->setEmpty('thumbnails.height', '90'); diff --git a/application/feed/FeedBuilder.php b/application/feed/FeedBuilder.php index b66f2f91..e23b3452 100644 --- a/application/feed/FeedBuilder.php +++ b/application/feed/FeedBuilder.php @@ -156,7 +156,7 @@ class FeedBuilder } else { $permalink = '' . t('Permalink') . ''; } - $link['description'] = format_description($link['description'], '', false, $pageaddr); + $link['description'] = format_description($link['description'], $pageaddr); $link['description'] .= PHP_EOL . '
— ' . $permalink; $pubDate = $link['created']; diff --git a/application/updater/Updater.php b/application/updater/Updater.php index f12e3516..beb9ea9b 100644 --- a/application/updater/Updater.php +++ b/application/updater/Updater.php @@ -218,7 +218,6 @@ class Updater try { $this->conf->set('general.title', escape($this->conf->get('general.title'))); $this->conf->set('general.header_link', escape($this->conf->get('general.header_link'))); - $this->conf->set('redirector.url', escape($this->conf->get('redirector.url'))); $this->conf->write($this->isLoggedIn); } catch (Exception $e) { error_log($e->getMessage()); @@ -550,4 +549,14 @@ class Updater return true; } + + /** + * Remove redirector settings. + */ + public function updateMethodRemoveRedirector() + { + $this->conf->remove('redirector'); + $this->conf->write(true); + return true; + } } diff --git a/doc/md/Shaarli-configuration.md b/doc/md/Shaarli-configuration.md index 920c7e27..8787f59d 100644 --- a/doc/md/Shaarli-configuration.md +++ b/doc/md/Shaarli-configuration.md @@ -120,11 +120,6 @@ Must be an associative array: `translation domain => translation path`. - **enable_thumbnails**: Enable or disable thumbnail display. - **enable_localcache**: Enable or disable local cache. -### Redirector - -- **url**: Redirector URL, such as `anonym.to`. -- **encode_url**: Enable this if the redirector needs encoded URL to work properly. - ## Configuration file example ```json @@ -185,8 +180,6 @@ Must be an associative array: `translation domain => translation path`. "hide_public_links": false, "hide_timestamps": false, "open_shaarli": false, - "redirector": "http://anonym.to/?", - "redirector_encode_url": false }, "general": { "header_link": "?", @@ -218,10 +211,6 @@ Must be an associative array: `translation domain => translation path`. "enable_thumbnails": true, "enable_localcache": true }, - "redirector": { - "url": "http://anonym.to/?", - "encode_url": false - }, "plugins": { "WALLABAG_URL": "http://demo.wallabag.org", "WALLABAG_VERSION": "1" diff --git a/index.php b/index.php index 633ab89e..9ea26c7c 100644 --- a/index.php +++ b/index.php @@ -312,9 +312,7 @@ function showDailyRSS($conf, $loginManager) $LINKSDB = new LinkDB( $conf->get('resource.datastore'), $loginManager->isLoggedIn(), - $conf->get('privacy.hide_public_links'), - $conf->get('redirector.url'), - $conf->get('redirector.encode_url') + $conf->get('privacy.hide_public_links') ); /* Some Shaarlies may have very few links, so we need to look @@ -356,11 +354,7 @@ function showDailyRSS($conf, $loginManager) // We pre-format some fields for proper output. foreach ($links as &$link) { - $link['formatedDescription'] = format_description( - $link['description'], - $conf->get('redirector.url'), - $conf->get('redirector.encode_url') - ); + $link['formatedDescription'] = format_description($link['description']); $link['timestamp'] = $link['created']->getTimestamp(); if (startsWith($link['url'], '?')) { $link['url'] = index_url($_SERVER) . $link['url']; // make permalink URL absolute @@ -433,11 +427,7 @@ function showDaily($pageBuilder, $LINKSDB, $conf, $pluginManager, $loginManager) $taglist = explode(' ', $link['tags']); uasort($taglist, 'strcasecmp'); $linksToDisplay[$key]['taglist']=$taglist; - $linksToDisplay[$key]['formatedDescription'] = format_description( - $link['description'], - $conf->get('redirector.url'), - $conf->get('redirector.encode_url') - ); + $linksToDisplay[$key]['formatedDescription'] = format_description($link['description']); $linksToDisplay[$key]['timestamp'] = $link['created']->getTimestamp(); } @@ -1662,11 +1652,7 @@ function buildLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager) $linkDisp = array(); while ($i<$end && $iget('redirector.url'), - $conf->get('redirector.encode_url') - ); + $link['description'] = format_description($link['description']); $classLi = ($i % 2) != 0 ? '' : 'publicLinkHightLight'; $link['class'] = $link['private'] == 0 ? $classLi : 'private'; $link['timestamp'] = $link['created']->getTimestamp(); @@ -1727,7 +1713,6 @@ function buildLinkList($PAGE, $LINKSDB, $conf, $pluginManager, $loginManager) 'search_term' => $searchterm, 'search_tags' => $searchtags, 'visibility' => ! empty($_SESSION['visibility']) ? $_SESSION['visibility'] : '', - 'redirector' => $conf->get('redirector.url'), // Optional redirector URL. 'links' => $linkDisp, ); @@ -1877,9 +1862,7 @@ try { $linkDb = new LinkDB( $conf->get('resource.datastore'), $loginManager->isLoggedIn(), - $conf->get('privacy.hide_public_links'), - $conf->get('redirector.url'), - $conf->get('redirector.encode_url') + $conf->get('privacy.hide_public_links') ); $container = new \Slim\Container(); diff --git a/tests/bookmark/LinkDBTest.php b/tests/bookmark/LinkDBTest.php index ff5c0b97..2990a6b5 100644 --- a/tests/bookmark/LinkDBTest.php +++ b/tests/bookmark/LinkDBTest.php @@ -361,36 +361,6 @@ class LinkDBTest extends \PHPUnit\Framework\TestCase ); } - /** - * Test real_url without redirector. - */ - public function testLinkRealUrlWithoutRedirector() - { - $db = new LinkDB(self::$testDatastore, false, false); - foreach ($db as $link) { - $this->assertEquals($link['url'], $link['real_url']); - } - } - - /** - * Test real_url with redirector. - */ - public function testLinkRealUrlWithRedirector() - { - $redirector = 'http://redirector.to?'; - $db = new LinkDB(self::$testDatastore, false, false, $redirector); - foreach ($db as $link) { - $this->assertStringStartsWith($redirector, $link['real_url']); - $this->assertNotFalse(strpos($link['real_url'], urlencode('://'))); - } - - $db = new LinkDB(self::$testDatastore, false, false, $redirector, false); - foreach ($db as $link) { - $this->assertStringStartsWith($redirector, $link['real_url']); - $this->assertFalse(strpos($link['real_url'], urlencode('://'))); - } - } - /** * Test filter with string. */ @@ -516,7 +486,7 @@ class LinkDBTest extends \PHPUnit\Framework\TestCase public function testRenameTagCaseSensitive() { self::$refDB->write(self::$testDatastore); - $linkDB = new LinkDB(self::$testDatastore, true, false, ''); + $linkDB = new LinkDB(self::$testDatastore, true, false); $res = $linkDB->renameTag('sTuff', 'Taz'); $this->assertEquals(1, count($res)); diff --git a/tests/bookmark/LinkUtilsTest.php b/tests/bookmark/LinkUtilsTest.php index 1b8688e6..bd08f036 100644 --- a/tests/bookmark/LinkUtilsTest.php +++ b/tests/bookmark/LinkUtilsTest.php @@ -216,56 +216,27 @@ class LinkUtilsTest extends \PHPUnit\Framework\TestCase } /** - * Test text2clickable without a redirector being set. + * Test text2clickable. */ - public function testText2clickableWithoutRedirector() + public function testText2clickable() { $text = 'stuff http://hello.there/is=someone#here otherstuff'; $expectedText = 'stuff ' . 'http://hello.there/is=someone#here otherstuff'; - $processedText = text2clickable($text, ''); + $processedText = text2clickable($text); $this->assertEquals($expectedText, $processedText); $text = 'stuff http://hello.there/is=someone#here(please) otherstuff'; $expectedText = 'stuff ' . 'http://hello.there/is=someone#here(please) otherstuff'; - $processedText = text2clickable($text, ''); + $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 ' . 'http://hello.there/is=someone#here(please)&no otherstuff'; - $processedText = text2clickable($text, ''); - $this->assertEquals($expectedText, $processedText); - } - - /** - * Test text2clickable with a redirector set. - */ - public function testText2clickableWithRedirector() - { - $text = 'stuff http://hello.there/is=someone#here otherstuff'; - $redirector = 'http://redirector.to'; - $expectedText = 'stuff http://hello.there/is=someone#here otherstuff'; - $processedText = text2clickable($text, $redirector); - $this->assertEquals($expectedText, $processedText); - } - - /** - * Test text2clickable a redirector set and without URL encode. - */ - public function testText2clickableWithRedirectorDontEncode() - { - $text = 'stuff http://hello.there/?is=someone&or=something#here otherstuff'; - $redirector = 'http://redirector.to'; - $expectedText = 'stuff http://hello.there/?is=someone&or=something#here otherstuff'; - $processedText = text2clickable($text, $redirector, false); + $processedText = text2clickable($text); $this->assertEquals($expectedText, $processedText); } diff --git a/tests/plugins/PluginMarkdownTest.php b/tests/plugins/PluginMarkdownTest.php index 5e7c02b0..9ddbc558 100644 --- a/tests/plugins/PluginMarkdownTest.php +++ b/tests/plugins/PluginMarkdownTest.php @@ -107,7 +107,7 @@ class PluginMarkdownTest extends \PHPUnit\Framework\TestCase public function testReverseText2clickable() { $text = 'stuff http://hello.there/is=someone#here otherstuff'; - $clickableText = text2clickable($text, ''); + $clickableText = text2clickable($text); $reversedText = reverse_text2clickable($clickableText); $this->assertEquals($text, $reversedText); } diff --git a/tests/updater/UpdaterTest.php b/tests/updater/UpdaterTest.php index d7df5963..93bc86c1 100644 --- a/tests/updater/UpdaterTest.php +++ b/tests/updater/UpdaterTest.php @@ -287,17 +287,14 @@ $GLOBALS[\'privateLinkByDefault\'] = true;'; $this->conf = new ConfigManager($sandbox); $title = ''; $headerLink = ''; - $redirectorUrl = ''; $this->conf->set('general.title', $title); $this->conf->set('general.header_link', $headerLink); - $this->conf->set('redirector.url', $redirectorUrl); $updater = new Updater(array(), array(), $this->conf, true); $done = $updater->updateMethodEscapeUnescapedConfig(); $this->assertTrue($done); $this->conf->reload(); $this->assertEquals(escape($title), $this->conf->get('general.title')); $this->assertEquals(escape($headerLink), $this->conf->get('general.header_link')); - $this->assertEquals(escape($redirectorUrl), $this->conf->get('redirector.url')); unlink($sandbox . '.json.php'); } @@ -707,7 +704,6 @@ $GLOBALS[\'privateLinkByDefault\'] = true;'; } /** -<<<<<<< HEAD * Test updateMethodWebThumbnailer with thumbnails enabled. */ public function testUpdateMethodWebThumbnailerEnabled() @@ -812,4 +808,19 @@ $GLOBALS[\'privateLinkByDefault\'] = true;'; $linkDB = new LinkDB(self::$testDatastore, true, false); $this->assertTrue($linkDB[1]['sticky']); } + + /** + * Test updateMethodRemoveRedirector(). + */ + public function testUpdateRemoveRedirector() + { + $sandboxConf = 'sandbox/config'; + copy(self::$configFile . '.json.php', $sandboxConf . '.json.php'); + $this->conf = new ConfigManager($sandboxConf); + $updater = new Updater([], null, $this->conf, true); + $this->assertTrue($updater->updateMethodRemoveRedirector()); + $this->assertFalse($this->conf->exists('redirector')); + $this->conf = new ConfigManager($sandboxConf); + $this->assertFalse($this->conf->exists('redirector')); + } }