first commit

This commit is contained in:
CHIEFSOFT\ameye
2024-06-08 17:09:23 -04:00
commit df3a033196
17887 changed files with 8637778 additions and 0 deletions
@@ -0,0 +1,135 @@
<?php
/**
* @file classes/components/form/publication/ContributorForm.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 ContributorForm
*
* @ingroup classes_controllers_form
*
* @brief A preset form for adding and editing a contributor for a publication.
*/
namespace PKP\components\forms\publication;
use APP\facades\Repo;
use APP\submission\Submission;
use PKP\components\forms\FieldOptions;
use PKP\components\forms\FieldRichTextarea;
use PKP\components\forms\FieldSelect;
use PKP\components\forms\FieldText;
use PKP\components\forms\FormComponent;
use PKP\context\Context;
use PKP\security\Role;
use PKP\userGroup\UserGroup;
use Sokil\IsoCodes\IsoCodesFactory;
define('FORM_CONTRIBUTOR', 'contributor');
class ContributorForm extends FormComponent
{
/** @copydoc FormComponent::$id */
public $id = FORM_CONTRIBUTOR;
/** @copydoc FormComponent::$method */
public $method = 'POST';
public Submission $submission;
public Context $context;
public function __construct(string $action, array $locales, Submission $submission, Context $context)
{
$this->action = $action;
$this->locales = $locales;
$this->submission = $submission;
$this->context = $context;
$authorUserGroupsOptions = Repo::userGroup()
->getCollector()
->filterByRoleIds([Role::ROLE_ID_AUTHOR])
->filterByContextIds([$context->getId()])
->getMany()
->map(fn (UserGroup $authorUserGroup) => [
'value' => (int) $authorUserGroup->getId(),
'label' => $authorUserGroup->getLocalizedName(),
]);
$isoCodes = app(IsoCodesFactory::class);
$countries = [];
foreach ($isoCodes->getCountries() as $country) {
$countries[] = [
'value' => $country->getAlpha2(),
'label' => $country->getLocalName()
];
}
usort($countries, function ($a, $b) {
return strcmp($a['label'], $b['label']);
});
$this->addField(new FieldText('givenName', [
'label' => __('user.givenName'),
'isMultilingual' => true,
'isRequired' => true
]))
->addField(new FieldText('familyName', [
'label' => __('user.familyName'),
'isMultilingual' => true,
]))
->addField(new FieldText('preferredPublicName', [
'label' => __('user.preferredPublicName'),
'description' => __('user.preferredPublicName.description'),
'isMultilingual' => true,
]))
->addField(new FieldText('email', [
'label' => __('user.email'),
'isRequired' => true,
]))
->addField(new FieldSelect('country', [
'label' => __('common.country'),
'options' => $countries,
'isRequired' => true,
]))
->addField(new FieldText('url', [
'label' => __('user.url'),
]))
->addField(new FieldText('orcid', [
'label' => __('user.orcid'),
]));
if ($context->getSetting('requireAuthorCompetingInterests')) $this->addField(new FieldRichTextarea('competingInterests', [
'label' => __('author.competingInterests'),
'description' => __('author.competingInterests.description'),
'isMultilingual' => true,
]));
$this->addField(new FieldRichTextarea('biography', [
'label' => __('user.biography'),
'isMultilingual' => true,
]))
->addField(new FieldText('affiliation', [
'label' => __('user.affiliation'),
'isMultilingual' => true,
]));
if ($authorUserGroupsOptions->count() > 1) {
$this->addField(new FieldOptions('userGroupId', [
'label' => __('submission.submit.contributorRole'),
'type' => 'radio',
'value' => $authorUserGroupsOptions->first()['value'],
'options' => $authorUserGroupsOptions->values(),
]));
} else {
$this->addHiddenField('userGroupId', $authorUserGroupsOptions->first()['value']);
}
$this->addField(new FieldOptions('includeInBrowse', [
'label' => __('submission.submit.includeInBrowse.title'),
'type' => 'checkbox',
'value' => true,
'options' => [
['value' => true, 'label' => __('submission.submit.includeInBrowse')],
]
]));
}
}
@@ -0,0 +1,56 @@
<?php
/**
* @file classes/components/form/publication/Details.php
*
* Copyright (c) 2014-2023 Simon Fraser University
* Copyright (c) 2000-2023 John Willinsky
* Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
*
* @class Details
*
* @ingroup classes_controllers_form
*
* @brief The Details form in the submission wizard.
*/
namespace PKP\components\forms\publication;
use APP\publication\Publication;
use PKP\components\forms\FieldControlledVocab;
use PKP\context\Context;
use PKP\submission\SubmissionKeywordDAO;
class Details extends TitleAbstractForm
{
/**
* Constructor
*
* @param string $suggestionUrlBase The base URL to get suggestions for controlled vocab.
*/
public function __construct(
string $action,
array $locales,
Publication $publication,
public Context $context,
public string $suggestionUrlBase,
int $abstractWordLimit = 0,
bool $isAbstractRequired = false
) {
parent::__construct($action, $locales, $publication, $abstractWordLimit, $isAbstractRequired);
$this->removeField('prefix');
$this->removeField('subtitle');
if (in_array($context->getData('keywords'), [Context::METADATA_REQUEST, Context::METADATA_REQUIRE])) {
$this->addField(new FieldControlledVocab('keywords', [
'label' => __('common.keywords'),
'description' => __('manager.setup.metadata.keywords.description'),
'isMultilingual' => true,
'apiUrl' => str_replace('__vocab__', SubmissionKeywordDAO::CONTROLLED_VOCAB_SUBMISSION_KEYWORD, $suggestionUrlBase),
'locales' => $this->locales,
'value' => (array) $publication->getData('keywords'),
'isRequired' => $context->getData('keywords') === Context::METADATA_REQUIRE ? true : false,
]), [FIELD_POSITION_AFTER, 'title']);
}
}
}
@@ -0,0 +1,47 @@
<?php
/**
* @file classes/components/form/publication/PKPCitationsForm.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 PKPCitationsForm
*
* @ingroup classes_controllers_form
*
* @brief A preset form for setting a publication's citations
*/
namespace PKP\components\forms\publication;
use APP\publication\Publication;
use PKP\components\forms\FieldTextarea;
use PKP\components\forms\FormComponent;
define('FORM_CITATIONS', 'citations');
class PKPCitationsForm extends FormComponent
{
public $id = FORM_CITATIONS;
public $method = 'PUT';
public bool $isRequired;
/**
* Constructor
*
* @param string $action URL to submit the form to
*/
public function __construct(string $action, Publication $publication, bool $isRequired = false)
{
$this->action = $action;
$this->isRequired = $isRequired;
$this->addField(new FieldTextarea('citationsRaw', [
'label' => __('submission.citations'),
'description' => __('submission.citations.description'),
'value' => $publication->getData('citationsRaw'),
'isRequired' => $isRequired
]));
}
}
@@ -0,0 +1,174 @@
<?php
/**
* @file classes/components/form/publication/PKPMetadataForm.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 PKPMetadataForm
*
* @ingroup classes_controllers_form
*
* @brief A preset form for setting a publication's metadata fields
*/
namespace PKP\components\forms\publication;
use APP\publication\Publication;
use PKP\components\forms\FieldControlledVocab;
use PKP\components\forms\FieldRichTextarea;
use PKP\components\forms\FieldText;
use PKP\components\forms\FormComponent;
use PKP\context\Context;
use PKP\submission\SubmissionAgencyDAO;
use PKP\submission\SubmissionDisciplineDAO;
use PKP\submission\SubmissionKeywordDAO;
use PKP\submission\SubmissionLanguageDAO;
use PKP\submission\SubmissionSubjectDAO;
define('FORM_METADATA', 'metadata');
class PKPMetadataForm extends FormComponent
{
public $id = FORM_METADATA;
public $method = 'PUT';
public Context $context;
public Publication $publication;
/**
* Constructor
*
* @param string $action URL to submit the form to
* @param array $locales Supported locales
* @param Publication $publication The publication to change settings for
* @param Context $context The journal or press of the submission.
* @param string $suggestionUrlBase The base URL to get suggestions for controlled vocab.
*/
public function __construct(string $action, array $locales, Publication $publication, Context $context, string $suggestionUrlBase)
{
$this->action = $action;
$this->locales = $locales;
$this->context = $context;
$this->publication = $publication;
if ($this->enabled('keywords')) {
$this->addField(new FieldControlledVocab('keywords', [
'label' => __('common.keywords'),
'tooltip' => __('manager.setup.metadata.keywords.description'),
'isMultilingual' => true,
'apiUrl' => str_replace('__vocab__', SubmissionKeywordDAO::CONTROLLED_VOCAB_SUBMISSION_KEYWORD, $suggestionUrlBase),
'locales' => $this->locales,
'value' => (array) $publication->getData('keywords'),
]));
}
if ($this->enabled('subjects')) {
$this->addField(new FieldControlledVocab('subjects', [
'label' => __('common.subjects'),
'tooltip' => __('manager.setup.metadata.subjects.description'),
'isMultilingual' => true,
'apiUrl' => str_replace('__vocab__', SubmissionSubjectDAO::CONTROLLED_VOCAB_SUBMISSION_SUBJECT, $suggestionUrlBase),
'locales' => $this->locales,
'value' => (array) $publication->getData('subjects'),
]));
}
if ($this->enabled('disciplines')) {
$this->addField(new FieldControlledVocab('disciplines', [
'label' => __('search.discipline'),
'tooltip' => __('manager.setup.metadata.disciplines.description'),
'isMultilingual' => true,
'apiUrl' => str_replace('__vocab__', SubmissionDisciplineDAO::CONTROLLED_VOCAB_SUBMISSION_DISCIPLINE, $suggestionUrlBase),
'locales' => $this->locales,
'value' => (array) $publication->getData('disciplines'),
]));
}
if ($this->enabled('languages')) {
$this->addField(new FieldControlledVocab('languages', [
'label' => __('common.languages'),
'tooltip' => __('manager.setup.metadata.languages.description'),
'isMultilingual' => true,
'apiUrl' => str_replace('__vocab__', SubmissionLanguageDAO::CONTROLLED_VOCAB_SUBMISSION_LANGUAGE, $suggestionUrlBase),
'locales' => $this->locales,
'value' => (array) $publication->getData('languages'),
]));
}
if ($this->enabled('agencies')) {
$this->addField(new FieldControlledVocab('supportingAgencies', [
'label' => __('submission.supportingAgencies'),
'tooltip' => __('manager.setup.metadata.agencies.description'),
'isMultilingual' => true,
'apiUrl' => str_replace('__vocab__', SubmissionAgencyDAO::CONTROLLED_VOCAB_SUBMISSION_AGENCY, $suggestionUrlBase),
'locales' => $this->locales,
'value' => (array) $publication->getData('supportingAgencies'),
]));
}
if ($this->enabled('coverage')) {
$this->addField(new FieldText('coverage', [
'label' => __('manager.setup.metadata.coverage'),
'tooltip' => __('manager.setup.metadata.coverage.description'),
'isMultilingual' => true,
'value' => $publication->getData('coverage'),
]));
}
if ($this->enabled('rights')) {
$this->addField(new FieldText('rights', [
'label' => __('submission.rights'),
'tooltip' => __('manager.setup.metadata.rights.description'),
'isMultilingual' => true,
'value' => $publication->getData('rights'),
]));
}
if ($this->enabled('source')) {
$this->addField(new FieldText('source', [
'label' => __('common.source'),
'tooltip' => __('manager.setup.metadata.source.description'),
'isMultilingual' => true,
'value' => $publication->getData('source'),
]));
}
if ($this->enabled('type')) {
$this->addField(new FieldText('type', [
'label' => __('common.type'),
'tooltip' => __('manager.setup.metadata.type.description'),
'isMultilingual' => true,
'value' => $publication->getData('type'),
]));
}
if ($this->enabled('dataAvailability')) {
$this->addField(new FieldRichTextarea('dataAvailability', [
'label' => __('submission.dataAvailability'),
'tooltip' => __('manager.setup.metadata.dataAvailability.description'),
'isMultilingual' => true,
'value' => $publication->getData('dataAvailability'),
]));
}
if ($this->enabled('pub-id::publisher-id')) {
$this->addField(new FieldText('pub-id::publisher-id', [
'label' => __('submission.publisherId'),
'tooltip' => __('submission.publisherId.description'),
'value' => $publication->getData('pub-id::publisher-id'),
]));
}
}
/**
* Whether or not a metadata field is enabled in this form
*/
protected function enabled(string $setting): bool
{
if ($setting === 'pub-id::publisher-id') {
return in_array('publication', (array) $this->context->getData('enablePublisherId'));
}
return (bool) $this->context->getData($setting);
}
}
@@ -0,0 +1,52 @@
<?php
/**
* @file classes/components/form/publication/PKPPublicationIdentifiersForm.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 PKPPublicationIdentifiersForm
*
* @ingroup classes_controllers_form
*
* @brief A preset form for setting a publication's public identifiers (DOI, etc)
*/
namespace PKP\components\forms\publication;
use APP\publication\Publication;
use PKP\components\forms\FormComponent;
define('FORM_PUBLICATION_IDENTIFIERS', 'publicationIdentifiers');
class PKPPublicationIdentifiersForm extends FormComponent
{
/** @copydoc FormComponent::$id */
public $id = FORM_PUBLICATION_IDENTIFIERS;
/** @copydoc FormComponent::$method */
public $method = 'PUT';
/** @var Publication The publication this form is for */
public $publication;
/** @var \PKP\context\Context The journal/press this publication exists in */
public $submissionContext;
/**
* Constructor
*
* @param string $action URL to submit the form to
* @param array $locales Supported locales
* @param Publication $publication The publication to change settings for
* @param \PKP\context\Context $submissionContext The journal/press this publication exists in
*/
public function __construct($action, $locales, $publication, $submissionContext)
{
$this->action = $action;
$this->locales = $locales;
$this->publication = $publication;
$this->submissionContext = $submissionContext;
}
}
@@ -0,0 +1,97 @@
<?php
/**
* @file classes/components/form/publication/PKPPublicationLicenseForm.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 PKPPublicationLicenseForm
*
* @ingroup classes_controllers_form
*
* @brief A preset form for setting a publication's license and copyright info
*/
namespace PKP\components\forms\publication;
use APP\core\Application;
use APP\publication\Publication;
use Illuminate\Support\LazyCollection;
use PKP\components\forms\FieldText;
use PKP\components\forms\FormComponent;
define('FORM_PUBLICATION_LICENSE', 'publicationLicense');
class PKPPublicationLicenseForm extends FormComponent
{
/** @copydoc FormComponent::$id */
public $id = FORM_PUBLICATION_LICENSE;
/** @copydoc FormComponent::$method */
public $method = 'PUT';
/**
* Constructor
*
* @param string $action URL to submit the form to
* @param array $locales Supported locales
* @param Publication $publication The publication to change settings for
* @param \PKP\context\Context $context The publication's context
* @param LazyCollection<int,\PKP\userGroup\UserGroup> $userGroups User groups in this context
*/
public function __construct($action, $locales, $publication, $context, LazyCollection $userGroups)
{
$this->action = $action;
$this->locales = $locales;
// Get the copyright that will be set on publication based on context settings
if ($context->getData('copyrightHolderType') === 'author') {
$copyright = $publication->getAuthorString($userGroups);
} elseif ($context->getData('copyrightHolderType') === 'other') {
$copyright = $context->getLocalizedData('copyrightHolderOther');
} else {
$copyright = $context->getLocalizedData('name');
}
// Get the name of the context's license setting
$licenseUrlDescription = '';
if ($context->getData('licenseUrl')) {
$licenseOptions = Application::getCCLicenseOptions();
if (array_key_exists($context->getData('licenseUrl'), $licenseOptions)) {
$licenseName = __($licenseOptions[$context->getData('licenseUrl')]);
} else {
$licenseName = $context->getData('licenseUrl');
}
$licenseUrlDescription = __('submission.license.description', [
'licenseUrl' => $context->getData('licenseUrl'),
'licenseName' => $licenseName,
]);
}
$this->addField(new FieldText('copyrightHolder', [
'label' => __('submission.copyrightHolder'),
'description' => __('submission.copyrightHolder.description', ['copyright' => htmlspecialchars($copyright)]),
'isMultilingual' => true,
'optIntoEdit' => !$publication->getData('copyrightHolder'),
'optIntoEditLabel' => __('common.override'),
'value' => $publication->getData('copyrightHolder'),
]))
->addField(new FieldText('copyrightYear', [
'label' => __('submission.copyrightYear'),
'description' => $context->getData('copyrightYearBasis') === 'issue'
? __('publication.copyrightYearBasis.issueDescription')
: __('publication.copyrightYearBasis.submissionDescription'),
'optIntoEdit' => !$publication->getData('copyrightYear'),
'optIntoEditLabel' => __('common.override'),
'value' => $publication->getData('copyrightYear'),
]))
->addField(new FieldText('licenseUrl', [
'label' => __('submission.licenseURL'),
'description' => $licenseUrlDescription,
'optIntoEdit' => $context->getData('licenseUrl') && !$publication->getData('licenseUrl'),
'optIntoEditLabel' => __('common.override'),
'value' => $publication->getData('licenseUrl'),
]));
}
}
@@ -0,0 +1,80 @@
<?php
/**
* @file classes/components/form/publication/TitleAbstractForm.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 TitleAbstractForm
*
* @ingroup classes_controllers_form
*
* @brief A preset form for setting a publication's title and abstract
*/
namespace PKP\components\forms\publication;
use APP\publication\Publication;
use PKP\components\forms\FieldRichText;
use PKP\components\forms\FieldRichTextarea;
use PKP\components\forms\FieldText;
use PKP\components\forms\FormComponent;
define('FORM_TITLE_ABSTRACT', 'titleAbstract');
class TitleAbstractForm extends FormComponent
{
public $id = FORM_TITLE_ABSTRACT;
public $method = 'PUT';
public $publication;
public int $abstractWordLimit;
public bool $isAbstractRequired;
/**
* Constructor
*
* @param int $abstractWordLimit The abstract word limit for this submission or 0 for no limit
* @param bool $isAbstractRequired Is the abstract required?
*/
public function __construct(
string $action,
array $locales,
Publication $publication,
int $abstractWordLimit = 0,
bool $isAbstractRequired = false
) {
$this->action = $action;
$this->locales = $locales;
$this->publication = $publication;
$this->abstractWordLimit = $abstractWordLimit;
$this->isAbstractRequired = $isAbstractRequired;
$this->addField(new FieldText('prefix', [
'label' => __('common.prefix'),
'description' => __('common.prefixAndTitle.tip'),
'size' => 'small',
'isMultilingual' => true,
'value' => $publication->getData('prefix'),
]))
->addField(new FieldRichText('title', [
'label' => __('common.title'),
'isMultilingual' => true,
'isRequired' => true,
'value' => $publication->getData('title'),
]))
->addField(new FieldRichText('subtitle', [
'label' => __('common.subtitle'),
'isMultilingual' => true,
'value' => $publication->getData('subtitle'),
]))
->addField(new FieldRichTextarea('abstract', [
'label' => __('common.abstract'),
'isMultilingual' => true,
'isRequired' => $this->isAbstractRequired,
'size' => 'large',
'wordLimit' => $this->abstractWordLimit,
'value' => $publication->getData('abstract'),
]));
}
}