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

Remove anonymous permission and initialize bookmarks on login

Browse source
This commit is contained in:
ArthurHoaro 2020-08-01 11:10:57 +02:00
parent f7f08ceec1
commit d6e5f04d39
8 changed files with 42 additions and 57 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
application/bookmark/BookmarkFileService.php
View file

@ -6,6 +6,7 @@ namespace Shaarli\Bookmark;
use Exception;
use Shaarli\Bookmark\Exception\BookmarkNotFoundException;
use Shaarli\Bookmark\Exception\DatastoreNotInitializedException;
use Shaarli\Bookmark\Exception\EmptyDataStoreException;
use Shaarli\Config\ConfigManager;
use Shaarli\Formatter\BookmarkMarkdownFormatter;
@ -46,9 +47,6 @@ class BookmarkFileService implements BookmarkServiceInterface
/** @var bool true for logged in users. Default value to retrieve private bookmarks. */
protected $isLoggedIn;
/** @var bool Allow datastore alteration from not logged in users. */
protected $anonymousPermission = false;
/**
* @inheritDoc
*/
@ -65,10 +63,16 @@ class BookmarkFileService implements BookmarkServiceInterface
} else {
try {
$this->bookmarks = $this->bookmarksIO->read();
} catch (EmptyDataStoreException $e) {
} catch (EmptyDataStoreException|DatastoreNotInitializedException $e) {
$this->bookmarks = new BookmarkArray();
if ($this->isLoggedIn) {
$this->save();
// Datastore file does not exists, we initialize it with default bookmarks.
if ($e instanceof DatastoreNotInitializedException) {
$this->initialize();
} else {
$this->save();
}
}
}
@ -157,7 +161,7 @@ class BookmarkFileService implements BookmarkServiceInterface
*/
public function set($bookmark, $save = true)
{
if (true !== $this->isLoggedIn && true !== $this->anonymousPermission) {
if (true !== $this->isLoggedIn) {
throw new Exception(t('You\'re not authorized to alter the datastore'));
}
if (! $bookmark instanceof Bookmark) {
@ -182,7 +186,7 @@ class BookmarkFileService implements BookmarkServiceInterface
*/
public function add($bookmark, $save = true)
{
if (true !== $this->isLoggedIn && true !== $this->anonymousPermission) {
if (true !== $this->isLoggedIn) {
throw new Exception(t('You\'re not authorized to alter the datastore'));
}
if (! $bookmark instanceof Bookmark) {
@ -207,7 +211,7 @@ class BookmarkFileService implements BookmarkServiceInterface
*/
public function addOrSet($bookmark, $save = true)
{
if (true !== $this->isLoggedIn && true !== $this->anonymousPermission) {
if (true !== $this->isLoggedIn) {
throw new Exception(t('You\'re not authorized to alter the datastore'));
}
if (! $bookmark instanceof Bookmark) {
@ -224,7 +228,7 @@ class BookmarkFileService implements BookmarkServiceInterface
*/
public function remove($bookmark, $save = true)
{
if (true !== $this->isLoggedIn && true !== $this->anonymousPermission) {
if (true !== $this->isLoggedIn) {
throw new Exception(t('You\'re not authorized to alter the datastore'));
}
if (! $bookmark instanceof Bookmark) {
@ -277,7 +281,7 @@ class BookmarkFileService implements BookmarkServiceInterface
*/
public function save()
{
if (true !== $this->isLoggedIn && true !== $this->anonymousPermission) {
if (true !== $this->isLoggedIn) {
// TODO: raise an Exception instead
die('You are not authorized to change the database.');
}
@ -359,16 +363,10 @@ class BookmarkFileService implements BookmarkServiceInterface
{
$initializer = new BookmarkInitializer($this);
$initializer->initialize();
}
public function enableAnonymousPermission(): void
{
$this->anonymousPermission = true;
}
public function disableAnonymousPermission(): void
{
$this->anonymousPermission = false;
if (true === $this->isLoggedIn) {
$this->save();
}
}
/**

8
application/bookmark/BookmarkIO.php
View file

@ -2,6 +2,7 @@
namespace Shaarli\Bookmark;
use Shaarli\Bookmark\Exception\DatastoreNotInitializedException;
use Shaarli\Bookmark\Exception\EmptyDataStoreException;
use Shaarli\Bookmark\Exception\NotWritableDataStoreException;
use Shaarli\Config\ConfigManager;
@ -52,13 +53,14 @@ class BookmarkIO
*
* @return BookmarkArray instance
*
* @throws NotWritableDataStoreException Data couldn't be loaded
* @throws EmptyDataStoreException Datastore doesn't exist
* @throws NotWritableDataStoreException Data couldn't be loaded
* @throws EmptyDataStoreException Datastore file exists but does not contain any bookmark
* @throws DatastoreNotInitializedException File does not exists
*/
public function read()
{
if (! file_exists($this->datastore)) {
throw new EmptyDataStoreException();
throw new DatastoreNotInitializedException();
}
if (!is_writable($this->datastore)) {

9
application/bookmark/BookmarkInitializer.php
View file

@ -6,8 +6,7 @@ namespace Shaarli\Bookmark;
* Class BookmarkInitializer
*
* This class is used to initialized default bookmarks after a fresh install of Shaarli.
* It is no longer call when the data store is empty,
* because user might want to delete default bookmarks after the install.
* It should be only called if the datastore file does not exist(users might want to delete the default bookmarks).
*
* To prevent data corruption, it does not overwrite existing bookmarks,
* even though there should not be any.
@ -34,8 +33,6 @@ class BookmarkInitializer
*/
public function initialize()
{
$this->bookmarkService->enableAnonymousPermission();
$bookmark = new Bookmark();
$bookmark->setTitle(t('My secret stuff... - Pastebin.com'));
$bookmark->setUrl('http://sebsauvage.net/paste/?8434b27936c09649#bR7XsXhoTiLcqCpQbmOpBi3rq2zzQUC5hBI7ZT1O3x8=');
@ -57,9 +54,5 @@ You use the community supported version of the original Shaarli project, by Seba
));
$bookmark->setTagsString('opensource software');
$this->bookmarkService->add($bookmark, false);
$this->bookmarkService->save();
$this->bookmarkService->disableAnonymousPermission();
}
}

14
application/bookmark/BookmarkServiceInterface.php
View file

@ -6,7 +6,6 @@ namespace Shaarli\Bookmark;
use Shaarli\Bookmark\Exception\BookmarkNotFoundException;
use Shaarli\Bookmark\Exception\NotWritableDataStoreException;
use Shaarli\Config\ConfigManager;
use Shaarli\Exceptions\IOException;
use Shaarli\History;
/**
@ -177,17 +176,4 @@ interface BookmarkServiceInterface
* Creates the default database after a fresh install.
*/
public function initialize();
/**
* Allow to write the datastore from anonymous session (not logged in).
*
* This covers a few specific use cases, such as datastore initialization,
* but it should be used carefully as it can lead to security issues.
*/
public function enableAnonymousPermission();
/**
* Disable anonymous permission.
*/
public function disableAnonymousPermission();
}

10
application/bookmark/exception/DatastoreNotInitializedException.php Normal file
View file

@ -0,0 +1,10 @@
<?php
declare(strict_types=1);
namespace Shaarli\Bookmark\Exception;
class DatastoreNotInitializedException extends \Exception
{
}

5
application/front/controller/visitor/InstallController.php
View file

@ -5,7 +5,6 @@ declare(strict_types=1);
namespace Shaarli\Front\Controller\Visitor;
use Shaarli\ApplicationUtils;
use Shaarli\Bookmark\BookmarkFilter;
use Shaarli\Container\ShaarliContainer;
use Shaarli\Front\Exception\AlreadyInstalledException;
use Shaarli\Front\Exception\ResourcePermissionException;
@ -140,10 +139,6 @@ class InstallController extends ShaarliVisitorController
return $response->write($this->render('error'));
}
if ($this->container->bookmarkService->count(BookmarkFilter::$ALL) === 0) {
$this->container->bookmarkService->initialize();
}
$this->container->sessionManager->setSessionParameter(
SessionManager::KEY_SUCCESS_MESSAGES,
[t('Shaarli is now configured. Please login and start shaaring your bookmarks!')]

14
tests/bookmark/BookmarkInitializerTest.php
View file

@ -3,7 +3,6 @@
namespace Shaarli\Bookmark;
use PHPUnit\Framework\TestCase;
use ReferenceLinkDB;
use Shaarli\Config\ConfigManager;
use Shaarli\History;
@ -54,9 +53,9 @@ class BookmarkInitializerTest extends TestCase
}
/**
* Test initialize() with an empty data store.
* Test initialize() with a data store containing bookmarks.
*/
public function testInitializeEmptyDataStore()
public function testInitializeNotEmptyDataStore(): void
{
$refDB = new \ReferenceLinkDB();
$refDB->write(self::$testDatastore);
@ -79,6 +78,8 @@ class BookmarkInitializerTest extends TestCase
);
$this->assertFalse($bookmark->isPrivate());
$this->bookmarkService->save();
// Reload from file
$this->bookmarkService = new BookmarkFileService($this->conf, $this->history, true);
$this->assertEquals($refDB->countLinks() + 2, $this->bookmarkService->count());
@ -97,10 +98,13 @@ class BookmarkInitializerTest extends TestCase
}
/**
* Test initialize() with a data store containing bookmarks.
* Test initialize() with an a non existent datastore file .
*/
public function testInitializeNotEmptyDataStore()
public function testInitializeNonExistentDataStore(): void
{
$this->conf->set('resource.datastore', static::$testDatastore . '_empty');
$this->bookmarkService = new BookmarkFileService($this->conf, $this->history, true);
$this->initializer->initialize();
$this->assertEquals(2, $this->bookmarkService->count());

3
tests/front/controller/visitor/InstallControllerTest.php
View file

@ -224,9 +224,6 @@ class InstallControllerTest extends TestCase
;
$this->container->conf->expects(static::once())->method('write');
$this->container->bookmarkService->expects(static::once())->method('count')->willReturn(0);
$this->container->bookmarkService->expects(static::once())->method('initialize');
$this->container->sessionManager
->expects(static::once())
->method('setSessionParameter')