CHIEFSOFT\ameye
349 lines
12 KiB
PHP
349 lines
12 KiB
PHP
<?php
|
|
|
|
/**
|
|
* @file controllers/grid/languages/LanguageGridHandler.php
|
|
*
|
|
* Copyright (c) 2014-2021 Simon Fraser University
|
|
* Copyright (c) 2000-2021 John Willinsky
|
|
* Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
|
|
*
|
|
* @class LanguageGridHandler
|
|
*
|
|
* @ingroup classes_controllers_grid_languages
|
|
*
|
|
* @brief Handle language grid requests.
|
|
*/
|
|
|
|
namespace PKP\controllers\grid\languages;
|
|
|
|
use APP\core\Application;
|
|
use APP\core\Request;
|
|
use APP\core\Services;
|
|
use APP\notification\NotificationManager;
|
|
use PKP\controllers\grid\GridColumn;
|
|
use PKP\controllers\grid\GridHandler;
|
|
use PKP\core\JSONMessage;
|
|
use PKP\facades\Locale;
|
|
use PKP\notification\PKPNotification;
|
|
use PKP\security\Role;
|
|
|
|
class LanguageGridHandler extends GridHandler
|
|
{
|
|
/**
|
|
* Constructor
|
|
*/
|
|
public function __construct()
|
|
{
|
|
parent::__construct();
|
|
$this->addRoleAssignment(
|
|
[Role::ROLE_ID_MANAGER, Role::ROLE_ID_SITE_ADMIN],
|
|
['saveLanguageSetting', 'setContextPrimaryLocale']
|
|
);
|
|
}
|
|
|
|
|
|
//
|
|
// Implement template methods from PKPHandler.
|
|
//
|
|
/**
|
|
* @copydoc GridHandler::initialize()
|
|
*
|
|
* @param null|mixed $args
|
|
*/
|
|
public function initialize($request, $args = null)
|
|
{
|
|
parent::initialize($request, $args);
|
|
|
|
// Basic grid configuration.
|
|
$this->setTitle('common.languages');
|
|
}
|
|
|
|
/**
|
|
* @copydoc GridHandler::getRowInstance()
|
|
*/
|
|
protected function getRowInstance()
|
|
{
|
|
return new LanguageGridRow();
|
|
}
|
|
|
|
//
|
|
// Public handler methods.
|
|
//
|
|
/**
|
|
* Save language management settings.
|
|
*
|
|
* @param array $args
|
|
* @param Request $request
|
|
*
|
|
* @return JSONMessage JSON message
|
|
*/
|
|
public function saveLanguageSetting($args, $request)
|
|
{
|
|
if (!$request->checkCSRF()) {
|
|
return new JSONMessage(false);
|
|
}
|
|
$locale = (string) $request->getUserVar('rowId');
|
|
$settingName = (string) $request->getUserVar('setting');
|
|
$settingValue = (bool) $request->getUserVar('value');
|
|
$availableLocales = $this->getGridDataElements($request);
|
|
$context = $request->getContext();
|
|
|
|
$contextService = Services::get('context');
|
|
|
|
$permittedSettings = ['supportedFormLocales', 'supportedSubmissionLocales', 'supportedLocales'];
|
|
if (in_array($settingName, $permittedSettings) && $locale) {
|
|
$currentSettingValue = (array) $context->getData($settingName);
|
|
if (Locale::isLocaleValid($locale) && array_key_exists($locale, $availableLocales)) {
|
|
if ($settingValue) {
|
|
array_push($currentSettingValue, $locale);
|
|
if ($settingName == 'supportedFormLocales') {
|
|
// reload localized default context settings
|
|
$contextService->restoreLocaleDefaults($context, $request, $locale);
|
|
} elseif ($settingName == 'supportedSubmissionLocales') {
|
|
// if a submission locale is enabled, and this locale is not in the form locales, add it
|
|
$supportedFormLocales = (array) $context->getData('supportedFormLocales');
|
|
if (!in_array($locale, $supportedFormLocales)) {
|
|
array_push($supportedFormLocales, $locale);
|
|
$context = $contextService->edit($context, ['supportedFormLocales' => $supportedFormLocales], $request);
|
|
// reload localized default context settings
|
|
$contextService->restoreLocaleDefaults($context, $request, $locale);
|
|
}
|
|
}
|
|
} else {
|
|
$key = array_search($locale, $currentSettingValue);
|
|
if ($key !== false) {
|
|
unset($currentSettingValue[$key]);
|
|
}
|
|
|
|
if ($currentSettingValue === []) {
|
|
return new JSONMessage(false, __('notification.localeSettingsCannotBeSaved'));
|
|
}
|
|
|
|
if ($settingName == 'supportedFormLocales') {
|
|
// if a form locale is disabled, disable it form submission locales as well
|
|
$supportedSubmissionLocales = (array) $context->getData('supportedSubmissionLocales');
|
|
$key = array_search($locale, $supportedSubmissionLocales);
|
|
if ($key !== false) {
|
|
unset($supportedSubmissionLocales[$key]);
|
|
}
|
|
$supportedSubmissionLocales = array_values($supportedSubmissionLocales);
|
|
if ($supportedSubmissionLocales == []) {
|
|
return new JSONMessage(false, __('notification.localeSettingsCannotBeSaved'));
|
|
}
|
|
$context = $contextService->edit($context, ['supportedSubmissionLocales' => $supportedSubmissionLocales], $request);
|
|
}
|
|
|
|
if ($settingName == 'supportedSubmissionLocales') {
|
|
// If someone tried to disable all submissions checkboxes, we should display an error message.
|
|
$supportedSubmissionLocales = (array) $context->getData('supportedSubmissionLocales');
|
|
$key = array_search($locale, $supportedSubmissionLocales);
|
|
if ($key !== false) {
|
|
unset($supportedSubmissionLocales[$key]);
|
|
}
|
|
$supportedSubmissionLocales = array_values($supportedSubmissionLocales);
|
|
if ($supportedSubmissionLocales == []) {
|
|
return new JSONMessage(false, __('notification.localeSettingsCannotBeSaved'));
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
$context = $contextService->edit($context, [$settingName => array_values(array_unique($currentSettingValue))], $request);
|
|
|
|
$notificationManager = new NotificationManager();
|
|
$user = $request->getUser();
|
|
$notificationManager->createTrivialNotification(
|
|
$user->getId(),
|
|
PKPNotification::NOTIFICATION_TYPE_SUCCESS,
|
|
['contents' => __('notification.localeSettingsSaved')]
|
|
);
|
|
|
|
$locales = $context->getSupportedFormLocaleNames();
|
|
$locales = array_map(fn (string $locale, string $name) => ['key' => $locale, 'label' => $name], array_keys($locales), $locales);
|
|
|
|
$json = \PKP\db\DAO::getDataChangedEvent($locale);
|
|
$json->setGlobalEvent('set-form-languages', $locales);
|
|
return $json;
|
|
}
|
|
|
|
/**
|
|
* Set context primary locale.
|
|
*
|
|
* @param array $args
|
|
* @param Request $request
|
|
*
|
|
* @return JSONMessage JSON object
|
|
*/
|
|
public function setContextPrimaryLocale($args, $request)
|
|
{
|
|
if (!$request->checkCSRF()) {
|
|
return new JSONMessage(false);
|
|
}
|
|
$locale = (string) $request->getUserVar('rowId');
|
|
$context = $request->getContext();
|
|
$availableLocales = $this->getGridDataElements($request);
|
|
|
|
if (Locale::isLocaleValid($locale) && array_key_exists($locale, $availableLocales)) {
|
|
// Make sure at least the primary locale is chosen as available
|
|
foreach (['supportedLocales', 'supportedSubmissionLocales', 'supportedFormLocales'] as $name) {
|
|
$$name = $context->getData($name);
|
|
if (!in_array($locale, $$name)) {
|
|
array_push($$name, $locale);
|
|
$context->updateSetting($name, $$name);
|
|
}
|
|
}
|
|
|
|
$context->setPrimaryLocale($locale);
|
|
$contextDao = Application::getContextDAO();
|
|
$contextDao->updateObject($context);
|
|
|
|
$notificationManager = new NotificationManager();
|
|
$user = $request->getUser();
|
|
$notificationManager->createTrivialNotification(
|
|
$user->getId(),
|
|
PKPNotification::NOTIFICATION_TYPE_SUCCESS,
|
|
['contents' => __('notification.localeSettingsSaved')]
|
|
);
|
|
}
|
|
|
|
return \PKP\db\DAO::getDataChangedEvent();
|
|
}
|
|
|
|
//
|
|
// Protected methods.
|
|
//
|
|
/**
|
|
* Return an instance of the cell provider
|
|
* used by this grid.
|
|
*
|
|
* @return LanguageGridCellProvider
|
|
*/
|
|
public function getCellProvider()
|
|
{
|
|
return new LanguageGridCellProvider();
|
|
}
|
|
|
|
/**
|
|
* Add name column.
|
|
*/
|
|
public function addNameColumn()
|
|
{
|
|
$cellProvider = $this->getCellProvider();
|
|
|
|
// Locale name.
|
|
$this->addColumn(
|
|
new GridColumn(
|
|
'locale',
|
|
'grid.columns.locale',
|
|
null,
|
|
'controllers/grid/languages/localeNameCell.tpl',
|
|
$cellProvider
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Add locale code column.
|
|
*/
|
|
public function addLocaleCodeColumn()
|
|
{
|
|
$cellProvider = $this->getCellProvider();
|
|
|
|
// Locale code.
|
|
$this->addColumn(
|
|
new GridColumn(
|
|
'code',
|
|
'grid.columns.locale.code',
|
|
null,
|
|
null,
|
|
$cellProvider
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Add primary column.
|
|
*
|
|
* @param string $columnId The column id.
|
|
*/
|
|
public function addPrimaryColumn($columnId)
|
|
{
|
|
$cellProvider = $this->getCellProvider();
|
|
|
|
$this->addColumn(
|
|
new GridColumn(
|
|
$columnId,
|
|
'locale.primary',
|
|
null,
|
|
'controllers/grid/common/cell/radioButtonCell.tpl',
|
|
$cellProvider
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Add columns related to management settings.
|
|
*/
|
|
public function addManagementColumns()
|
|
{
|
|
$cellProvider = $this->getCellProvider();
|
|
$this->addColumn(
|
|
new GridColumn(
|
|
'uiLocale',
|
|
'manager.language.ui',
|
|
null,
|
|
'controllers/grid/common/cell/selectStatusCell.tpl',
|
|
$cellProvider
|
|
)
|
|
);
|
|
|
|
$this->addColumn(
|
|
new GridColumn(
|
|
'formLocale',
|
|
'manager.language.forms',
|
|
null,
|
|
'controllers/grid/common/cell/selectStatusCell.tpl',
|
|
$cellProvider
|
|
)
|
|
);
|
|
|
|
$this->addColumn(
|
|
new GridColumn(
|
|
'submissionLocale',
|
|
'manager.language.submissions',
|
|
null,
|
|
'controllers/grid/common/cell/selectStatusCell.tpl',
|
|
$cellProvider
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Add data related to management settings.
|
|
*
|
|
* @param Request $request
|
|
* @param array $data Data already loaded.
|
|
*
|
|
* @return array Same passed array, but with
|
|
* the extra management data inserted.
|
|
*/
|
|
public function addManagementData($request, $data)
|
|
{
|
|
$context = $request->getContext();
|
|
|
|
if (is_array($data)) {
|
|
foreach ($data as $locale => $localeData) {
|
|
foreach (['supportedFormLocales', 'supportedSubmissionLocales', 'supportedLocales'] as $name) {
|
|
$data[$locale][$name] = in_array($locale, $context->getData($name));
|
|
// $data[$locale][$name] = in_array($locale, (array) $context->getData($name));
|
|
}
|
|
}
|
|
} else {
|
|
assert(false);
|
|
}
|
|
|
|
return $data;
|
|
}
|
|
}
|