Skip to content

Commit

Permalink
refactor(settings): Create a UserSettingsService and load all setting…
Browse files Browse the repository at this point in the history 
…s via initial state

Signed-off-by: Marcel Klehr <[email protected]>
  • Loading branch information
@marcelklehr
marcelklehr committed Jan 28, 2024
1 parent a5752fe commit 4121990
Show file tree
Hide file tree
Showing 6 changed files with 133 additions and 288 deletions.
15 changes: 2 additions & 13 deletions appinfo/routes.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -128,19 +128,8 @@
['name' => 'folders#delete_share', 'url' => '/public/rest/v2/share/{shareId}', 'verb' => 'DELETE'],

//Settings
['name' => 'settings#set_sorting', 'url' => '/settings/sorting', 'verb' => 'POST'],
['name' => 'settings#get_sorting', 'url' => '/settings/sorting', 'verb' => 'GET'],
['name' => 'settings#set_view_mode', 'url' => '/settings/viewMode', 'verb' => 'POST'],
['name' => 'settings#get_view_mode', 'url' => '/settings/viewMode', 'verb' => 'GET'],
['name' => 'settings#set_archive_path', 'url' => '/settings/archivePath', 'verb' => 'POST'],
['name' => 'settings#get_archive_path', 'url' => '/settings/archivePath', 'verb' => 'GET'],
['name' => 'settings#set_backup_path', 'url' => '/settings/backupPath', 'verb' => 'POST'],
['name' => 'settings#get_backup_path', 'url' => '/settings/backupPath', 'verb' => 'GET'],
['name' => 'settings#set_backup_enabled', 'url' => '/settings/backupEnabled', 'verb' => 'POST'],
['name' => 'settings#get_backup_enabled', 'url' => '/settings/backupEnabled', 'verb' => 'GET'],
['name' => 'settings#set_whatsnew', 'url' => '/settings/hasSeenWhatsnew', 'verb' => 'POST'],
['name' => 'settings#get_whatsnew', 'url' => '/settings/hasSeenWhatsnew', 'verb' => 'GET'],
['name' => 'settings#get_limit', 'url' => '/settings/limit', 'verb' => 'GET'],
['name' => 'settings#set_setting', 'url' => '/settings/{key}', 'verb' => 'POST'],
['name' => 'settings#get_setting', 'url' => '/settings/{key}', 'verb' => 'GET'],

# public link web view
['name' => 'web_view#link', 'url' => '/public/{token}', 'verb' => 'GET'],
Expand Down
230 changes: 14 additions & 216 deletions lib/Controller/SettingsController.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,248 +7,46 @@

namespace OCA\Bookmarks\Controller;

use Exception;
use OCA\Bookmarks\Service\UserSettingsService;
use OCP\AppFramework\ApiController;
use OCP\AppFramework\Http;
use OCP\AppFramework\Http\JSONResponse;
use OCP\IConfig;
use OCP\IL10N;
use OCP\IRequest;

class SettingsController extends ApiController {
/** @var IConfig */
private $config;

/** @var string */
private $userId;
/**
* @var IL10N
*/
private $l;

/**
* @param string $appName
* @param IRequest $request
* @param string $userId
* @param IConfig $config
* @param IL10N $l
* @param UserSettingsService $userSettingsService
*/
public function __construct(
$appName, $request, $userId, IConfig $config, IL10N $l
$appName, $request,
private UserSettingsService $userSettingsService,
) {
parent::__construct($appName, $request);
$this->config = $config;
$this->userId = $userId;
$this->l = $l;
}

private function getSetting(string $key, string $name, $default): JSONResponse {
public function getSetting(string $key): JSONResponse {
try {
$userValue = $this->config->getUserValue(
$this->userId,
$this->appName,
$key,
$default
);
} catch (Exception $e) {
return new JSONResponse([], Http::STATUS_INTERNAL_SERVER_ERROR);
$value = $this->userSettingsService->get($key);
} catch (\UnexpectedValueException) {
return new JSONResponse([], Http::STATUS_BAD_REQUEST);
}

return new JSONResponse([$name => $userValue], Http::STATUS_OK);
return new JSONResponse([$key => $value], Http::STATUS_OK);
}

private function setSetting(string $key, string $value): JSONResponse {
public function setSetting(string $key, string $value): JSONResponse {
try {
$this->config->setUserValue(
$this->userId,
$this->appName,
$key,
$value
);
} catch (Exception $e) {
return new JSONResponse(['status' => 'error'], Http::STATUS_INTERNAL_SERVER_ERROR);
}

return new JSONResponse(['status' => 'success'], Http::STATUS_OK);
}

/**
* get sorting option config value
*
* @return JSONResponse
*
* @NoAdminRequired
*/
public function getSorting(): JSONResponse {
return $this->getSetting('sorting', 'sorting', 'lastmodified');
}

/**
* set sorting option config value
*
* @param string $sorting
* @return JSONResponse
*
* @NoAdminRequired
*/
public function setSorting($sorting = ""): JSONResponse {
$legalArguments = ['title', 'added', 'clickcount', 'lastmodified', 'index', 'url'];
if (!in_array($sorting, $legalArguments)) {
$this->userSettingsService->set($key, $value);
} catch (\ValueError) {
return new JSONResponse(['status' => 'error'], Http::STATUS_BAD_REQUEST);
}
return $this->setSetting(
'sorting',
$sorting
);
}

/**
* get view mode option config value
*
* @return JSONResponse
*
* @NoAdminRequired
*/
public function getViewMode(): JSONResponse {
return $this->getSetting('viewMode', 'viewMode', 'grid');
}

/**
* set sorting option config value
*
* @param string $viewMode
* @return JSONResponse
*
* @NoAdminRequired
*/
public function setViewMode($viewMode = ""): JSONResponse {
$legalArguments = ['grid', 'list'];
if (!in_array($viewMode, $legalArguments)) {
} catch (\UnexpectedValueException) {
return new JSONResponse(['status' => 'error'], Http::STATUS_BAD_REQUEST);
}
return $this->setSetting(
'viewMode',
$viewMode
);
}

/**
* get per-user bookmarks limit
*
* @return JSONResponse
*
* @NoAdminRequired
*/
public function getLimit(): JSONResponse {
$limit = (int)$this->config->getAppValue('bookmarks', 'performance.maxBookmarksperAccount', 0);
return new JSONResponse(['limit' => $limit], Http::STATUS_OK);
}

/**
* get user-defined archive path
*
* @return JSONResponse
*
* @NoAdminRequired
*/
public function getArchivePath(): JSONResponse {
return $this->getSetting(
'archive.filePath',
'archivePath',
$this->l->t('Bookmarks')
);
}

/**
* set user-defined archive path
*
* @param string $archivePath
* @return JSONResponse
*
* @NoAdminRequired
*/
public function setArchivePath(string $archivePath): JSONResponse {
return $this->setSetting('archive.filePath', $archivePath);
}

/**
* get user-defined archive path
*
* @return JSONResponse
*
* @NoAdminRequired
*/
public function getBackupEnabled(): JSONResponse {
return $this->getSetting(
'backup.enabled',
'backupEnabled',
(string) false
);
}

/**
* set user-defined backup path
*
* @param string $backupEnabled
* @return JSONResponse
*
* @NoAdminRequired
*/
public function setBackupEnabled(bool $backupEnabled): JSONResponse {
return $this->setSetting('backup.enabled', (string) $backupEnabled);
}

/**
* get user-defined archive path
*
* @return JSONResponse
*
* @NoAdminRequired
*/
public function getBackupPath(): JSONResponse {
return $this->getSetting(
'backup.filePath',
'backupPath',
$this->l->t('Bookmarks Backups')
);
}

/**
* set user-defined backup path
*
* @param string $backupPath
* @return JSONResponse
*
* @NoAdminRequired
*/
public function setBackupPath(string $backupPath): JSONResponse {
return $this->setSetting('backup.filePath', $backupPath);
}

/**
* get hasSeenWhatsnew
*
* @return JSONResponse
*
* @NoAdminRequired
*/
public function getWhatsnew(): JSONResponse {
return $this->getSetting(
'hasSeenWhatsnew',
'hasSeenWhatsnew',
'0'
);
return new JSONResponse(['status' => 'success'], Http::STATUS_OK);
}

/**
* set hasSeenWhatsnew
*
* @param string $hasSeenWhatsnew
* @return JSONResponse
*
* @NoAdminRequired
*/
public function setWhatsnew(string $hasSeenWhatsnew): JSONResponse {
return $this->setSetting('hasSeenWhatsnew', $hasSeenWhatsnew);
}
}
62 changes: 14 additions & 48 deletions lib/Controller/WebViewController.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
use OCA\Bookmarks\Db\FolderMapper;
use OCA\Bookmarks\Db\PublicFolder;
use OCA\Bookmarks\Db\PublicFolderMapper;
use OCA\Bookmarks\Service\UserSettingsService;
use OCP\AppFramework\Controller;
use OCP\AppFramework\Db\DoesNotExistException;
use OCP\AppFramework\Db\MultipleObjectsReturnedException;
Expand All @@ -31,41 +32,6 @@ class WebViewController extends Controller {
/** @var string */
private $userId;

/**
* @var IL10N
*/
private $l;

/**
* @var PublicFolderMapper
*/
private $publicFolderMapper;

/**
* @var IUserManager
*/
private $userManager;
/**
* @var FolderMapper
*/
private $folderMapper;
/**
* @var IURLGenerator
*/
private $urlGenerator;
/**
* @var \OCP\IInitialStateService
*/
private $initialState;
/**
* @var InternalFoldersController
*/
private $folderController;
/**
* @var IConfig
*/
private $config;


/**
* WebViewController constructor.
Expand All @@ -82,17 +48,20 @@ class WebViewController extends Controller {
* @param InternalFoldersController $folderController
* @param IConfig $config
*/
public function __construct($appName, $request, $userId, IL10N $l, PublicFolderMapper $publicFolderMapper, IUserManager $userManager, FolderMapper $folderMapper, IURLGenerator $urlGenerator, \OCP\IInitialStateService $initialState, \OCA\Bookmarks\Controller\InternalFoldersController $folderController, IConfig $config) {
public function __construct(
$appName,
IRequest $request,
string $userId,
private IL10N $l,
private PublicFolderMapper $publicFolderMapper,
private IUserManager $userManager,
private FolderMapper $folderMapper,
private IURLGenerator $urlGenerator,
private \OCP\IInitialStateService $initialState,
private \OCA\Bookmarks\Controller\InternalFoldersController $folderController,
private UserSettingsService $userSettingsService) {
parent::__construct($appName, $request);
$this->userId = $userId;
$this->l = $l;
$this->publicFolderMapper = $publicFolderMapper;
$this->userManager = $userManager;
$this->folderMapper = $folderMapper;
$this->urlGenerator = $urlGenerator;
$this->initialState = $initialState;
$this->folderController = $folderController;
$this->config = $config;
}

/**
Expand All @@ -115,10 +84,7 @@ public function index(): AugmentedTemplateResponse {
// Provide complete folder hierarchy
$this->initialState->provideInitialState($this->appName, 'folders', $this->folderController->getFolders()->getData()['data']);

$settings = [];
foreach (['sorting', 'viewMode', 'hasSeenWhatsnew'] as $setting) {
$settings[$setting] = $this->config->getUserValue($this->userId, $this->appName, $setting);
}
$settings = $this->userSettingsService->toArray();
$this->initialState->provideInitialState($this->appName, 'settings', $settings);

return $res;
Expand Down
Loading

0 comments on commit 4121990

Please sign in to comment.