From 85149a75edd32edc00c84da994f6c6f066c70ca7 Mon Sep 17 00:00:00 2001 From: mlnkng Date: Wed, 19 Jul 2023 11:10:00 -0700 Subject: [PATCH] Add diacritics setting --- .../actions/diacriticsAction.class.php | 101 ++++++++++++++++++ .../settings/actions/editAction.class.php | 3 +- .../settings/actions/menuComponent.class.php | 4 + .../settings/templates/diacriticsSuccess.php | 57 ++++++++++ .../settings/templates/diacriticsSuccess.php | 57 ++++++++++ .../lib/arElasticSearchPlugin.class.php | 34 +++++- 6 files changed, 253 insertions(+), 3 deletions(-) create mode 100644 apps/qubit/modules/settings/actions/diacriticsAction.class.php create mode 100644 apps/qubit/modules/settings/templates/diacriticsSuccess.php create mode 100644 plugins/arDominionB5Plugin/modules/settings/templates/diacriticsSuccess.php diff --git a/apps/qubit/modules/settings/actions/diacriticsAction.class.php b/apps/qubit/modules/settings/actions/diacriticsAction.class.php new file mode 100644 index 0000000000..1109d053ba --- /dev/null +++ b/apps/qubit/modules/settings/actions/diacriticsAction.class.php @@ -0,0 +1,101 @@ +. + */ + +class SettingsDiacriticsAction extends SettingsEditAction +{ + // Arrays not allowed in class constants + public static $NAMES = [ + 'diacritics', + ]; + + public function earlyExecute() + { + parent::earlyExecute(); + + $this->updateMessage = $this->i18n->__('Diacritics settings saved.'); + + $this->settingDefaults = [ + 'diacritics' => 0, + ]; + } + + public function processForm() + { + foreach ($this->form as $field) { + $this->processField($field); + } + + $this->uploadDiacritics(); + } + + public function uploadDiacritics() + { + if (!$this->form->isValid()) { + return; + } + + $file = $this->form->getValue('mappings'); + + $diacriticsMappingPath = + sfConfig::get('sf_config_dir').DIRECTORY_SEPARATOR. + 'diacritics_mapping.yml'; + + if (null !== $file) { + try { + sfYaml::load($file->getTempName()); + + if (!move_uploaded_file($file->getTempName(), $diacriticsMappingPath)) { + $this->getUser()->setFlash('error', $this->context->i18n->__( + 'Unable to upload diacritics mapping yaml file.' + )); + unset($this->updateMessage); + + return; + } + } catch (Exception $e) { + // Reset diacritics settings when uploading yaml fails + QubitSetting::findAndSave('diacritics', 0, ['sourceCulture' => true]); + unlink($diacriticsMappingPath); + $this->getUser()->setFlash('error', $this->context->i18n->__( + 'Unable to upload diacritics mapping yaml file.' + )); + unset($this->updateMessage); + + return; + } + } else { + // Reset diacritics settings when uploading yaml fails + QubitSetting::findAndSave('diacritics', 0, ['sourceCulture' => true]); + unlink($diacriticsMappingPath); + } + } + + protected function addField($name) + { + switch ($name) { + case 'diacritics': + $this->form->setDefault($name, $this->settingDefaults[$name]); + $this->form->setWidget($name, new sfWidgetFormSelectRadio(['choices' => [0 => $this->i18n->__('Disabled'), 1 => $this->i18n->__('Enabled')]], ['class' => 'radio'])); + $this->form->setValidator($name, new sfValidatorChoice(['choices' => [1, 0]])); + $this->form->setWidget('mappings', new sfWidgetFormInputFile([], ['accept' => '.yml,.yaml'])); + $this->form->setValidator('mappings', new sfValidatorFile()); + + break; + } + } +} diff --git a/apps/qubit/modules/settings/actions/editAction.class.php b/apps/qubit/modules/settings/actions/editAction.class.php index e868af28d7..b07169c870 100644 --- a/apps/qubit/modules/settings/actions/editAction.class.php +++ b/apps/qubit/modules/settings/actions/editAction.class.php @@ -1,5 +1,4 @@ isMethod('post')) { - $this->form->bind($request->getPostParameters()); + $this->form->bind($request->getPostParameters(), $request->getFiles()); if ($this->form->isValid()) { $this->processForm(); diff --git a/apps/qubit/modules/settings/actions/menuComponent.class.php b/apps/qubit/modules/settings/actions/menuComponent.class.php index 2948c80290..621f2ae063 100644 --- a/apps/qubit/modules/settings/actions/menuComponent.class.php +++ b/apps/qubit/modules/settings/actions/menuComponent.class.php @@ -39,6 +39,10 @@ public function execute($request) 'label' => $i18n->__('Default template'), 'action' => 'template', ], + [ + 'label' => $i18n->__('Diacritics'), + 'action' => 'diacritics', + ], [ 'label' => $i18n->__('Digital object derivatives'), 'action' => 'digitalObjectDerivatives', diff --git a/apps/qubit/modules/settings/templates/diacriticsSuccess.php b/apps/qubit/modules/settings/templates/diacriticsSuccess.php new file mode 100644 index 0000000000..47075e3a6b --- /dev/null +++ b/apps/qubit/modules/settings/templates/diacriticsSuccess.php @@ -0,0 +1,57 @@ + + + + + + + + + +

+ + + + +
+

+ 
$ php symfony search:populate
+
+ + renderGlobalErrors(); ?> + + renderFormTag(url_for(['module' => 'settings', 'action' => 'diacritics']), ['method' => 'post']); ?> + + renderHiddenFields(); ?> + +
+ + + + + + + + + + + + + + + + + + +
diacritics; ?>
+
+ mappings; ?>
+
+
+ +
+ +
+ + + + diff --git a/plugins/arDominionB5Plugin/modules/settings/templates/diacriticsSuccess.php b/plugins/arDominionB5Plugin/modules/settings/templates/diacriticsSuccess.php new file mode 100644 index 0000000000..9185b46e00 --- /dev/null +++ b/plugins/arDominionB5Plugin/modules/settings/templates/diacriticsSuccess.php @@ -0,0 +1,57 @@ + + + + + + + + + +

+ + + + +
+

+ 
$ php symfony search:populate
+
+ + renderGlobalErrors(); ?> + + renderFormTag(url_for(['module' => 'settings', 'action' => 'diacritics']), ['method' => 'post']); ?> + + renderHiddenFields(); ?> + +
+ + + + + + + + + + + + + + + + + + +
diacritics; ?>
+
+ mappings; ?>
+
+
+ +
+ +
+ + + + diff --git a/plugins/arElasticSearchPlugin/lib/arElasticSearchPlugin.class.php b/plugins/arElasticSearchPlugin/lib/arElasticSearchPlugin.class.php index 39862e184d..d28c997178 100644 --- a/plugins/arElasticSearchPlugin/lib/arElasticSearchPlugin.class.php +++ b/plugins/arElasticSearchPlugin/lib/arElasticSearchPlugin.class.php @@ -135,6 +135,22 @@ public static function loadMappings() return $esMapping; } + public function loadDiacriticsMappings() + { + // Find diacritics_mapping.yml + $diacriticsFinder = sfFinder::type('file')->name('diacritics_mapping.yml'); + $diacriticsFiles = array_unique(array_merge( + $diacriticsFinder->in(sfConfig::get('sf_config_dir')), + $diacriticsFinder->in(ProjectConfiguration::getActive()->getPluginSubPaths('/config')) + )); + + if (!count($diacriticsFiles)) { + throw new sfException('You must create a diacritics_mapping.yml file.'); + } + + return sfYaml::load(array_shift($diacriticsFiles)); + } + /** * Optimize index. * @@ -468,6 +484,12 @@ public static function modelClassFromQubitObjectClass($className) */ protected function initialize() { + if (sfConfig::get('app_diacritics')) { + $this->config['index']['configuration']['analysis']['char_filter']['diacritics_lowercase'] = $this->loadDiacriticsMappings(); + } + + $this->loadMappings(); + try { $this->index->open(); } catch (Exception $e) { @@ -479,7 +501,17 @@ protected function initialize() && isset($this->config['index']['configuration']['analysis']['char_filter']['strip_md']) ) { foreach ($this->config['index']['configuration']['analysis']['analyzer'] as $key => $analyzer) { - $this->config['index']['configuration']['analysis']['analyzer'][$key]['char_filter'] = ['strip_md']; + $filters = ['strip_md']; + + if ($this->config['index']['configuration']['analysis']['analyzer'][$key]['char_filter']) { + $filters = array_merge($filters, $this->config['index']['configuration']['analysis']['analyzer'][$key]['char_filter']); + } + + if (sfConfig::get('app_diacritics')) { + $filters = array_merge($filters, ['diacritics_lowercase']); + } + + $this->config['index']['configuration']['analysis']['analyzer'][$key]['char_filter'] = $filters; } }