Skip to content

Simultaneously Displaying Multilingual Metadata on the Article Landing Page #574

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
139 changes: 139 additions & 0 deletions pages/preprint/PreprintHandler.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,18 +22,23 @@
use APP\facades\Repo;
use APP\handler\Handler;
use APP\observers\events\UsageEvent;
use APP\publication\Publication;
use APP\security\authorization\OpsServerMustPublishPolicy;
use APP\template\TemplateManager;
use Firebase\JWT\JWT;
use Illuminate\Support\Arr;
use PKP\author\Author;
use PKP\citation\CitationDAO;
use PKP\config\Config;
use PKP\core\Core;
use PKP\core\PKPApplication;
use PKP\db\DAORegistry;
use PKP\facades\Locale;
use PKP\orcid\OrcidManager;
use PKP\plugins\Hook;
use PKP\plugins\PluginRegistry;
use PKP\security\authorization\ContextRequiredPolicy;
use PKP\services\PKPSchemaService;
use PKP\submission\Genre;
use PKP\submission\GenreDAO;
use PKP\submission\PKPSubmission;
Expand Down Expand Up @@ -302,6 +307,16 @@ public function view($args, $request)
$templateMgr->addHeader('canonical', '<link rel="canonical" href="' . $url . '">');
}

$templateMgr->assign('pubLocaleData', $this->getMultilingualMetadataOpts(
$publication,
$templateMgr->getTemplateVars('currentLocale'),
$templateMgr->getTemplateVars('activeTheme')->getOption('showMultilingualMetadata') ?: [],
));
$templateMgr->registerPlugin('modifier', 'wrapData', fn (...$args) => $this->smartyWrapData($templateMgr, ...$args));
$templateMgr->registerPlugin('modifier', 'useFilters', fn (...$args) => $this->smartyUseFilters($templateMgr, ...$args));
$templateMgr->registerPlugin('modifier', 'getAuthorFullNames', $this->smartyGetAuthorFullNames(...));
$templateMgr->registerPlugin('modifier', 'getAffiliationNamesWithRors', $this->smartyGetAffiliationNamesWithRors(...));

if (!Hook::call('PreprintHandler::view', [&$request, &$preprint, $publication])) {
$templateMgr->display('frontend/pages/preprint.tpl');
event(new UsageEvent(Application::ASSOC_TYPE_SUBMISSION, $context, $preprint));
Expand Down Expand Up @@ -424,4 +439,128 @@ public function userCanViewGalley($request)
}
return false;
}

/**
* Multilingual publication metadata for template:
* showMultilingualMetadataOpts - Show metadata in other languages: title (+ subtitle), keywords, abstract, etc.
*/
protected function getMultilingualMetadataOpts(Publication $publication, string $currentUILocale, array $showMultilingualMetadataOpts): array
{
// Affiliation languages are not in multiligual props
$authorsLocales = collect($publication->getData('authors'))
->map(fn ($author): array => $this->getAuthorLocales($author))
->flatten()
->unique()
->values()
->toArray();
$langNames = collect($publication->getLanguageNames() + Locale::getSubmissionLocaleDisplayNames($authorsLocales))
->sortKeys();
$langs = $langNames->keys();

return [
'opts' => array_flip($showMultilingualMetadataOpts),
'uiLocale' => $currentUILocale,
'localeNames' => $langNames,
'localeOrder' => collect($publication->getLocalePrecedence())
->intersect($langs) /* remove locales not in publication's languages */
->concat($langs)
->unique()
->values()
->toArray(),
'accessibility' => [
'localeNames' => $langNames,
'langAttrs' => $langNames->map(fn ($_, $l) => preg_replace(['/@.+$/', '/_/'], ['', '-'], $l))->toArray() /* remove @ and text after */,
],
];
}

/**
* Publication's multilingual data to array for js and page
*/
protected function smartyWrapData(TemplateManager $templateMgr, array $data, string $switcher, ?array $filters = null, ?string $separator = null): array
{
return [
'switcher' => $switcher,
'data' => collect($data)
->map(
fn ($val): string => collect(Arr::wrap($val))
->when($filters, fn ($value) => $value->map(fn ($v) => $this->smartyUseFilters($templateMgr, $v, $filters)))
->when($separator, fn ($value): string => $value->join($separator), fn ($value): string => $value->first())
)
->toArray(),
'defaultLocale' => collect($templateMgr->getTemplateVars('pubLocaleData')['localeOrder'])
->first(fn (string $locale) => isset($data[$locale])),
];
}

/**
* Smarty template: Apply filters to given value
*/
protected function smartyUseFilters(TemplateManager $templateMgr, string $value, ?array $filters): string
{
if (!$filters) {
return $value;
}
foreach ($filters as $filter) {
$params = Arr::wrap($filter);
$funcName = array_shift($params);
if ($func = $templateMgr->registered_plugins['modifier'][$funcName][0] ?? null) {
$value = $func($value, ...$params);
} else {
error_log("{$funcName} : No such modifier in template registered plugins.");
}
}
return $value;
}

/**
* Smarty template: Get author's full names to multilingual array including all multilingual and affiliation languages as default localized name
*/
protected function smartyGetAuthorFullNames(Author $author): array
{
return collect($this->getAuthorLocales($author))
->mapWithKeys(fn (string $locale) => [$locale => $author->getFullName(preferredLocale: $locale)])
->toArray();
}

/**
* Smarty template: Get authors' affiliations with rors
*/
protected function smartyGetAffiliationNamesWithRors(Author $author): array
{
$affiliations = collect($author->getAffiliations());

return collect($this->getAuthorLocales($author))
->flip()
->map(
fn ($_, string $locale) => $affiliations
->map(fn ($affiliation): array => [
'name' => $affiliation->getAffiliationName($locale),
'ror' => $affiliation->getRor(),
])
->filter(fn (array $nameRor) => $nameRor['name'])
->toArray()
)
->filter()
->toArray();
}

/**
* Aux for smarty template functions: Get author's locales from multilingual props and affiliations
*/
protected function getAuthorLocales(Author $author): array
{
$multilingualLocales = collect(app()->get('schema')->getMultilingualProps(PKPSchemaService::SCHEMA_AUTHOR))
->map(fn (string $prop): array => array_keys($author->getData($prop) ?? []));
$affiliationLocales = collect($author->getAffiliations())
->flatten()
->map(fn ($affiliation): array => array_keys($affiliation->getData('name') ?? []));

return $multilingualLocales
->concat($affiliationLocales)
->flatten()
->unique()
->values()
->toArray();
}
}
24 changes: 24 additions & 0 deletions plugins/themes/default/DefaultThemePlugin.php
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,30 @@ public function init()
'default' => 'none',
]);

$this->addOption('showMultilingualMetadata', 'FieldOptions', [
'label' => __('plugins.themes.default.option.metadata.label'),
'description' => __('plugins.themes.default.option.metadata.description'),
'options' => [
[
'value' => 'title',
'label' => __('submission.title'),
],
[
'value' => 'keywords',
'label' => __('common.keywords'),
],
[
'value' => 'abstract',
'label' => __('common.abstract'),
],
[
'value' => 'author',
'label' => __('default.groups.name.author'),
],
],
'default' => [],
]);

// Load primary stylesheet
$this->addStyle('stylesheet', 'styles/index.less');

Expand Down
Loading
Loading