Knah-Tsaeb/MyShaarli
Knah-Tsaeb/MyShaarli
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Merge pull request #673 from virtualtam/cleanup/linkdb

Browse source 
LinkDB: code cleanup
This commit is contained in:
VirtualTam 2016-10-21 11:04:52 +02:00 committed by GitHub
commit 3d5e0aede3
6 changed files with 88 additions and 88 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

154
application/LinkDB.php
View file

@ -31,7 +31,7 @@
class LinkDB implements Iterator, Countable, ArrayAccess class LinkDB implements Iterator, Countable, ArrayAccess
{ {
// Links are stored as a PHP serialized string // Links are stored as a PHP serialized string
private $_datastore; private $datastore;
// Link date storage format // Link date storage format
const LINK_DATE_FORMAT = 'Ymd_His'; const LINK_DATE_FORMAT = 'Ymd_His';
@ -45,26 +45,26 @@ class LinkDB implements Iterator, Countable, ArrayAccess
// List of links (associative array) // List of links (associative array)
// - key: link date (e.g. "20110823_124546"), // - key: link date (e.g. "20110823_124546"),
// - value: associative array (keys: title, description...) // - value: associative array (keys: title, description...)
private $_links; private $links;
// List of all recorded URLs (key=url, value=linkdate) // List of all recorded URLs (key=url, value=linkdate)
// for fast reserve search (url-->linkdate) // for fast reserve search (url-->linkdate)
private $_urls; private $urls;
// List of linkdate keys (for the Iterator interface implementation) // List of linkdate keys (for the Iterator interface implementation)
private $_keys; private $keys;
// Position in the $this->_keys array (for the Iterator interface) // Position in the $this->keys array (for the Iterator interface)
private $_position; private $position;
// Is the user logged in? (used to filter private links) // Is the user logged in? (used to filter private links)
private $_loggedIn; private $loggedIn;
// Hide public links // Hide public links
private $_hidePublicLinks; private $hidePublicLinks;
// link redirector set in user settings. // link redirector set in user settings.
private $_redirector; private $redirector;
/** /**
* Set this to `true` to urlencode link behind redirector link, `false` to leave it untouched. * Set this to `true` to urlencode link behind redirector link, `false` to leave it untouched.
@ -87,7 +87,7 @@ class LinkDB implements Iterator, Countable, ArrayAccess
* @param string $redirector link redirector set in user settings. * @param string $redirector link redirector set in user settings.
* @param boolean $redirectorEncode Enable urlencode on redirected urls (default: true). * @param boolean $redirectorEncode Enable urlencode on redirected urls (default: true).
*/ */
function __construct( public function __construct(
$datastore, $datastore,
$isLoggedIn, $isLoggedIn,
$hidePublicLinks, $hidePublicLinks,
@ -95,13 +95,13 @@ function __construct(
$redirectorEncode = true $redirectorEncode = true
) )
{ {
$this->_datastore = $datastore; $this->datastore = $datastore;
$this->_loggedIn = $isLoggedIn; $this->loggedIn = $isLoggedIn;
$this->_hidePublicLinks = $hidePublicLinks; $this->hidePublicLinks = $hidePublicLinks;
$this->_redirector = $redirector; $this->redirector = $redirector;
$this->redirectorEncode = $redirectorEncode === true; $this->redirectorEncode = $redirectorEncode === true;
$this->_checkDB(); $this->check();
$this->_readDB(); $this->read();
} }
/** /**
@ -109,7 +109,7 @@ function __construct(
*/ */
public function count() public function count()
{ {
return count($this->_links); return count($this->links);
} }
/** /**
@ -118,7 +118,7 @@ public function count()
public function offsetSet($offset, $value) public function offsetSet($offset, $value)
{ {
// TODO: use exceptions instead of "die" // TODO: use exceptions instead of "die"
if (!$this->_loggedIn) { if (!$this->loggedIn) {
die('You are not authorized to add a link.'); die('You are not authorized to add a link.');
} }
if (empty($value['linkdate']) || empty($value['url'])) { if (empty($value['linkdate']) || empty($value['url'])) {
@ -127,8 +127,8 @@ public function offsetSet($offset, $value)
if (empty($offset)) { if (empty($offset)) {
die('You must specify a key.'); die('You must specify a key.');
} }
$this->_links[$offset] = $value; $this->links[$offset] = $value;
$this->_urls[$value['url']]=$offset; $this->urls[$value['url']]=$offset;
} }
/** /**
@ -136,7 +136,7 @@ public function offsetSet($offset, $value)
*/ */
public function offsetExists($offset) public function offsetExists($offset)
{ {
return array_key_exists($offset, $this->_links); return array_key_exists($offset, $this->links);
} }
/** /**
@ -144,13 +144,13 @@ public function offsetExists($offset)
*/ */
public function offsetUnset($offset) public function offsetUnset($offset)
{ {
if (!$this->_loggedIn) { if (!$this->loggedIn) {
// TODO: raise an exception // TODO: raise an exception
die('You are not authorized to delete a link.'); die('You are not authorized to delete a link.');
} }
$url = $this->_links[$offset]['url']; $url = $this->links[$offset]['url'];
unset($this->_urls[$url]); unset($this->urls[$url]);
unset($this->_links[$offset]); unset($this->links[$offset]);
} }
/** /**
@ -158,31 +158,31 @@ public function offsetUnset($offset)
*/ */
public function offsetGet($offset) public function offsetGet($offset)
{ {
return isset($this->_links[$offset]) ? $this->_links[$offset] : null; return isset($this->links[$offset]) ? $this->links[$offset] : null;
} }
/** /**
* Iterator - Returns the current element * Iterator - Returns the current element
*/ */
function current() public function current()
{ {
return $this->_links[$this->_keys[$this->_position]]; return $this->links[$this->keys[$this->position]];
} }
/** /**
* Iterator - Returns the key of the current element * Iterator - Returns the key of the current element
*/ */
function key() public function key()
{ {
return $this->_keys[$this->_position]; return $this->keys[$this->position];
} }
/** /**
* Iterator - Moves forward to next element * Iterator - Moves forward to next element
*/ */
function next() public function next()
{ {
++$this->_position; ++$this->position;
} }
/** /**
@ -190,19 +190,19 @@ function next()
* *
* Entries are sorted by date (latest first) * Entries are sorted by date (latest first)
*/ */
function rewind() public function rewind()
{ {
$this->_keys = array_keys($this->_links); $this->keys = array_keys($this->links);
rsort($this->_keys); rsort($this->keys);
$this->_position = 0; $this->position = 0;
} }
/** /**
* Iterator - Checks if current position is valid * Iterator - Checks if current position is valid
*/ */
function valid() public function valid()
{ {
return isset($this->_keys[$this->_position]); return isset($this->keys[$this->position]);
} }
/** /**
@ -210,14 +210,14 @@ function valid()
* *
* If no DB file is found, creates a dummy DB. * If no DB file is found, creates a dummy DB.
*/ */
private function _checkDB() private function check()
{ {
if (file_exists($this->_datastore)) { if (file_exists($this->datastore)) {
return; return;
} }
// Create a dummy database for example // Create a dummy database for example
$this->_links = array(); $this->links = array();
$link = array( $link = array(
'title'=>' Shaarli: the personal, minimalist, super-fast, no-database delicious clone', 'title'=>' Shaarli: the personal, minimalist, super-fast, no-database delicious clone',
'url'=>'https://github.com/shaarli/Shaarli/wiki', 'url'=>'https://github.com/shaarli/Shaarli/wiki',
@ -230,7 +230,7 @@ private function _checkDB()
'linkdate'=> date('Ymd_His'), 'linkdate'=> date('Ymd_His'),
'tags'=>'opensource software' 'tags'=>'opensource software'
); );
$this->_links[$link['linkdate']] = $link; $this->links[$link['linkdate']] = $link;
$link = array( $link = array(
'title'=>'My secret stuff... - Pastebin.com', 'title'=>'My secret stuff... - Pastebin.com',
@ -240,64 +240,64 @@ private function _checkDB()
'linkdate'=> date('Ymd_His', strtotime('-1 minute')), 'linkdate'=> date('Ymd_His', strtotime('-1 minute')),
'tags'=>'secretstuff' 'tags'=>'secretstuff'
); );
$this->_links[$link['linkdate']] = $link; $this->links[$link['linkdate']] = $link;
// Write database to disk // Write database to disk
$this->writeDB(); $this->write();
} }
/** /**
* Reads database from disk to memory * Reads database from disk to memory
*/ */
private function _readDB() private function read()
{ {
// Public links are hidden and user not logged in => nothing to show // Public links are hidden and user not logged in => nothing to show
if ($this->_hidePublicLinks && !$this->_loggedIn) { if ($this->hidePublicLinks && !$this->loggedIn) {
$this->_links = array(); $this->links = array();
return; return;
} }
// Read data // Read data
// Note that gzinflate is faster than gzuncompress. // Note that gzinflate is faster than gzuncompress.
// See: http://www.php.net/manual/en/function.gzdeflate.php#96439 // See: http://www.php.net/manual/en/function.gzdeflate.php#96439
$this->_links = array(); $this->links = array();
if (file_exists($this->_datastore)) { if (file_exists($this->datastore)) {
$this->_links = unserialize(gzinflate(base64_decode( $this->links = unserialize(gzinflate(base64_decode(
substr(file_get_contents($this->_datastore), substr(file_get_contents($this->datastore),
strlen(self::$phpPrefix), -strlen(self::$phpSuffix))))); strlen(self::$phpPrefix), -strlen(self::$phpSuffix)))));
} }
// If user is not logged in, filter private links. // If user is not logged in, filter private links.
if (!$this->_loggedIn) { if (!$this->loggedIn) {
$toremove = array(); $toremove = array();
foreach ($this->_links as $link) { foreach ($this->links as $link) {
if ($link['private'] != 0) { if ($link['private'] != 0) {
$toremove[] = $link['linkdate']; $toremove[] = $link['linkdate'];
} }
} }
foreach ($toremove as $linkdate) { foreach ($toremove as $linkdate) {
unset($this->_links[$linkdate]); unset($this->links[$linkdate]);
} }
} }
$this->_urls = array(); $this->urls = array();
foreach ($this->_links as &$link) { foreach ($this->links as &$link) {
// Keep the list of the mapping URLs-->linkdate up-to-date. // Keep the list of the mapping URLs-->linkdate up-to-date.
$this->_urls[$link['url']] = $link['linkdate']; $this->urls[$link['url']] = $link['linkdate'];
// Sanitize data fields. // Sanitize data fields.
sanitizeLink($link); sanitizeLink($link);
// Remove private tags if the user is not logged in. // Remove private tags if the user is not logged in.
if (! $this->_loggedIn) { if (! $this->loggedIn) {
$link['tags'] = preg_replace('/(^|\s+)\.[^($|\s)]+\s*/', ' ', $link['tags']); $link['tags'] = preg_replace('/(^|\s+)\.[^($|\s)]+\s*/', ' ', $link['tags']);
} }
// Do not use the redirector for internal links (Shaarli note URL starting with a '?'). // Do not use the redirector for internal links (Shaarli note URL starting with a '?').
if (!empty($this->_redirector) && !startsWith($link['url'], '?')) { if (!empty($this->redirector) && !startsWith($link['url'], '?')) {
$link['real_url'] = $this->_redirector; $link['real_url'] = $this->redirector;
if ($this->redirectorEncode) { if ($this->redirectorEncode) {
$link['real_url'] .= urlencode(unescape($link['url'])); $link['real_url'] .= urlencode(unescape($link['url']));
} else { } else {
@ -315,19 +315,19 @@ private function _readDB()
* *
* @throws IOException the datastore is not writable * @throws IOException the datastore is not writable
*/ */
private function writeDB() private function write()
{ {
if (is_file($this->_datastore) && !is_writeable($this->_datastore)) { if (is_file($this->datastore) && !is_writeable($this->datastore)) {
// The datastore exists but is not writeable // The datastore exists but is not writeable
throw new IOException($this->_datastore); throw new IOException($this->datastore);
} else if (!is_file($this->_datastore) && !is_writeable(dirname($this->_datastore))) { } else if (!is_file($this->datastore) && !is_writeable(dirname($this->datastore))) {
// The datastore does not exist and its parent directory is not writeable // The datastore does not exist and its parent directory is not writeable
throw new IOException(dirname($this->_datastore)); throw new IOException(dirname($this->datastore));
} }
file_put_contents( file_put_contents(
$this->_datastore, $this->datastore,
self::$phpPrefix.base64_encode(gzdeflate(serialize($this->_links))).self::$phpSuffix self::$phpPrefix.base64_encode(gzdeflate(serialize($this->links))).self::$phpSuffix
); );
} }
@ -337,14 +337,14 @@ private function writeDB()
* *
* @param string $pageCacheDir page cache directory * @param string $pageCacheDir page cache directory
*/ */
public function savedb($pageCacheDir) public function save($pageCacheDir)
{ {
if (!$this->_loggedIn) { if (!$this->loggedIn) {
// TODO: raise an Exception instead // TODO: raise an Exception instead
die('You are not authorized to change the database.'); die('You are not authorized to change the database.');
} }
$this->writeDB(); $this->write();
invalidateCaches($pageCacheDir); invalidateCaches($pageCacheDir);
} }
@ -358,8 +358,8 @@ public function savedb($pageCacheDir)
*/ */
public function getLinkFromUrl($url) public function getLinkFromUrl($url)
{ {
if (isset($this->_urls[$url])) { if (isset($this->urls[$url])) {
return $this->_links[$this->_urls[$url]]; return $this->links[$this->urls[$url]];
} }
return false; return false;
} }
@ -376,7 +376,7 @@ public function getLinkFromUrl($url)
public function filterHash($request) public function filterHash($request)
{ {
$request = substr($request, 0, 6); $request = substr($request, 0, 6);
$linkFilter = new LinkFilter($this->_links); $linkFilter = new LinkFilter($this->links);
return $linkFilter->filter(LinkFilter::$FILTER_HASH, $request); return $linkFilter->filter(LinkFilter::$FILTER_HASH, $request);
} }
@ -388,7 +388,7 @@ public function filterHash($request)
* @return array list of shaare found. * @return array list of shaare found.
*/ */
public function filterDay($request) { public function filterDay($request) {
$linkFilter = new LinkFilter($this->_links); $linkFilter = new LinkFilter($this->links);
return $linkFilter->filter(LinkFilter::$FILTER_DAY, $request); return $linkFilter->filter(LinkFilter::$FILTER_DAY, $request);
} }
@ -430,7 +430,7 @@ public function filterSearch($filterRequest = array(), $casesensitive = false, $
$request = ''; $request = '';
} }
$linkFilter = new LinkFilter($this->_links); $linkFilter = new LinkFilter($this->links);
return $linkFilter->filter($type, $request, $casesensitive, $privateonly); return $linkFilter->filter($type, $request, $casesensitive, $privateonly);
} }
@ -442,7 +442,7 @@ public function allTags()
{ {
$tags = array(); $tags = array();
$caseMapping = array(); $caseMapping = array();
foreach ($this->_links as $link) { foreach ($this->links as $link) {
foreach (preg_split('/\s+/', $link['tags'], 0, PREG_SPLIT_NO_EMPTY) as $tag) { foreach (preg_split('/\s+/', $link['tags'], 0, PREG_SPLIT_NO_EMPTY) as $tag) {
if (empty($tag)) { if (empty($tag)) {
continue; continue;
@ -467,7 +467,7 @@ public function allTags()
public function days() public function days()
{ {
$linkDays = array(); $linkDays = array();
foreach (array_keys($this->_links) as $day) { foreach (array_keys($this->links) as $day) {
$linkDays[substr($day, 0, 8)] = 0; $linkDays[substr($day, 0, 8)] = 0;
} }
$linkDays = array_keys($linkDays); $linkDays = array_keys($linkDays);

2
application/NetscapeBookmarkUtils.php
View file

@ -183,7 +183,7 @@ public static function import($post, $files, $linkDb, $pagecache)
$importCount++; $importCount++;
} }
$linkDb->savedb($pagecache); $linkDb->save($pagecache);
return self::importStatus( return self::importStatus(
$filename, $filename,
$filesize, $filesize,

2
application/Updater.php
View file

@ -143,7 +143,7 @@ public function updateMethodRenameDashTags()
$link['tags'] = implode(' ', array_unique(LinkFilter::tagsStrToArray($link['tags'], true))); $link['tags'] = implode(' ', array_unique(LinkFilter::tagsStrToArray($link['tags'], true)));
$this->linkDB[$link['linkdate']] = $link; $this->linkDB[$link['linkdate']] = $link;
} }
$this->linkDB->savedb($this->conf->get('resource.page_cache')); $this->linkDB->save($this->conf->get('resource.page_cache'));
return true; return true;
} }

8
index.php
View file

@ -1211,7 +1211,7 @@ function renderPage($conf, $pluginManager)
$value['tags']=trim(implode(' ',$tags)); $value['tags']=trim(implode(' ',$tags));
$LINKSDB[$key]=$value; $LINKSDB[$key]=$value;
} }
$LINKSDB->savedb($conf->get('resource.page_cache')); $LINKSDB->save($conf->get('resource.page_cache'));
echo '<script>alert("Tag was removed from '.count($linksToAlter).' links.");document.location=\'?\';</script>'; echo '<script>alert("Tag was removed from '.count($linksToAlter).' links.");document.location=\'?\';</script>';
exit; exit;
} }
@ -1228,7 +1228,7 @@ function renderPage($conf, $pluginManager)
$value['tags']=trim(implode(' ',$tags)); $value['tags']=trim(implode(' ',$tags));
$LINKSDB[$key]=$value; $LINKSDB[$key]=$value;
} }
$LINKSDB->savedb($conf->get('resource.page_cache')); // Save to disk. $LINKSDB->save($conf->get('resource.page_cache')); // Save to disk.
echo '<script>alert("Tag was renamed in '.count($linksToAlter).' links.");document.location=\'?searchtags='.urlencode($_POST['totag']).'\';</script>'; echo '<script>alert("Tag was renamed in '.count($linksToAlter).' links.");document.location=\'?searchtags='.urlencode($_POST['totag']).'\';</script>';
exit; exit;
} }
@ -1283,7 +1283,7 @@ function renderPage($conf, $pluginManager)
$pluginManager->executeHooks('save_link', $link); $pluginManager->executeHooks('save_link', $link);
$LINKSDB[$linkdate] = $link; $LINKSDB[$linkdate] = $link;
$LINKSDB->savedb($conf->get('resource.page_cache')); $LINKSDB->save($conf->get('resource.page_cache'));
pubsubhub($conf); pubsubhub($conf);
// If we are called from the bookmarklet, we must close the popup: // If we are called from the bookmarklet, we must close the popup:
@ -1325,7 +1325,7 @@ function renderPage($conf, $pluginManager)
$pluginManager->executeHooks('delete_link', $LINKSDB[$linkdate]); $pluginManager->executeHooks('delete_link', $LINKSDB[$linkdate]);
unset($LINKSDB[$linkdate]); unset($LINKSDB[$linkdate]);
$LINKSDB->savedb('resource.page_cache'); // save to disk $LINKSDB->save('resource.page_cache'); // save to disk
// If we are called from the bookmarklet, we must close the popup: // If we are called from the bookmarklet, we must close the popup:
if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) { echo '<script>self.close();</script>'; exit; } if (isset($_GET['source']) && ($_GET['source']=='bookmarklet' || $_GET['source']=='firefoxsocialapi')) { echo '<script>self.close();</script>'; exit; }

8
tests/LinkDBTest.php
View file

@ -117,7 +117,7 @@ public function testCheckDBNew()
unlink(self::$testDatastore); unlink(self::$testDatastore);
$this->assertFileNotExists(self::$testDatastore); $this->assertFileNotExists(self::$testDatastore);
$checkDB = self::getMethod('_checkDB'); $checkDB = self::getMethod('check');
$checkDB->invokeArgs($linkDB, array()); $checkDB->invokeArgs($linkDB, array());
$this->assertFileExists(self::$testDatastore); $this->assertFileExists(self::$testDatastore);
@ -134,7 +134,7 @@ public function testCheckDBLoad()
$datastoreSize = filesize(self::$testDatastore); $datastoreSize = filesize(self::$testDatastore);
$this->assertGreaterThan(0, $datastoreSize); $this->assertGreaterThan(0, $datastoreSize);
$checkDB = self::getMethod('_checkDB'); $checkDB = self::getMethod('check');
$checkDB->invokeArgs($linkDB, array()); $checkDB->invokeArgs($linkDB, array());
// ensure the datastore is left unmodified // ensure the datastore is left unmodified
@ -180,7 +180,7 @@ public function testReadPrivateDB()
/** /**
* Save the links to the DB * Save the links to the DB
*/ */
public function testSaveDB() public function testSave()
{ {
$testDB = new LinkDB(self::$testDatastore, true, false); $testDB = new LinkDB(self::$testDatastore, true, false);
$dbSize = sizeof($testDB); $dbSize = sizeof($testDB);
@ -194,7 +194,7 @@ public function testSaveDB()
'tags'=>'unit test' 'tags'=>'unit test'
); );
$testDB[$link['linkdate']] = $link; $testDB[$link['linkdate']] = $link;
$testDB->savedb('tests'); $testDB->save('tests');
$testDB = new LinkDB(self::$testDatastore, true, false); $testDB = new LinkDB(self::$testDatastore, true, false);
$this->assertEquals($dbSize + 1, sizeof($testDB)); $this->assertEquals($dbSize + 1, sizeof($testDB));

2
tests/utils/ReferenceLinkDB.php
View file

@ -13,7 +13,7 @@ class ReferenceLinkDB
/** /**
* Populates the test DB with reference data * Populates the test DB with reference data
*/ */
function __construct() public function __construct()
{ {
$this->addLink( $this->addLink(
'Link title: @website', 'Link title: @website',