Skip to content
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.

Sign up for GitHub

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

Jump to bottom

pkp/pkp-lib#10131 cleanup for Orcid implementation cleanup #10370

Merged
merged 1 commit into from
Sep 11, 2024
Merged

pkp/pkp-lib#10131 cleanup for Orcid implementation cleanup #10370

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
137 changes: 73 additions & 64 deletions api/v1/orcid/OrcidController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@

namespace PKP\API\v1\orcid;

use APP\author\Author;
use APP\facades\Repo;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\Request;
Expand Down Expand Up @@ -72,45 +73,15 @@ public function getGroupRoutes(): void
public function requestAuthorVerification(Request $illuminateRequest): JsonResponse
{
$context = $this->getRequest()->getContext();
if (!OrcidManager::isEnabled($context)) {
return response()->json([
'error' => __('api.orcid.403.orcidNotEnabled'),
], Response::HTTP_FORBIDDEN);
}

$authorId = (int) $illuminateRequest->route('authorId');
$author = Repo::author()->get($authorId);
$validate = $this->validateRequest($illuminateRequest);

if (empty($author)) {
if ($validate['error']) {
return response()->json([
'error' => __('api.orcid.404.authorNotFound'),
], Response::HTTP_NOT_FOUND);
}

$user = $this->getRequest()->getUser();
$currentRoles = array_map(
function (Role $role) {
return $role->getId();
},
$user->getRoles($context->getId())
);

if (!array_intersect([Role::ROLE_ID_SITE_ADMIN, Role::ROLE_ID_MANAGER], $currentRoles)) {
$publicationId = $author->getData('publicationId');
$submissionId = Repo::publication()->get($publicationId)->getData('submissionId');

$editorAssignment = StageAssignment::withSubmissionIds([$submissionId])
->withRoleIds([Role::ROLE_ID_SUB_EDITOR])
->withUserId($user->getId())
->first();

if ($editorAssignment === null) {
return response()->json([
'error' => __('api.orcid.403.editWithoutPermission'),
], Response::HTTP_FORBIDDEN);
}
'error' => $validate['error'],
], $validate['status']);
}

$author = $validate['author']; /** @var Author $author */
try {
dispatch(new SendAuthorMail($author, $context, true));
} catch (\Exception $exception) {
Expand All @@ -128,51 +99,89 @@ function (Role $role) {
*/
public function deleteForAuthor(Request $illuminateRequest): JsonResponse
{
$context = $this->getRequest()->getContext();
if (!OrcidManager::isEnabled($context)) {
return response()->json([
'error' => __('api.orcid.403.orcidNotEnabled'),
], Response::HTTP_FORBIDDEN);
$validate = $this->validateRequest($illuminateRequest);

if ($validate['error']) {
return response()->json(['error' => $validate['error']], $validate['status']);
}

$authorId = (int) $illuminateRequest->route('authorId');
$author = Repo::author()->get($authorId);
$author = $validate['author']; /** @var Author $author */

if (empty($author)) {
return response()->json([
'error' => __('api.orcid.404.authorNotFound'),
], Response::HTTP_NOT_FOUND);
}
$author->setOrcid(null);
$author->setOrcidVerified(false);
OrcidManager::removeOrcidAccessToken($author);
Repo::author()->edit($author, []);

return response()->json([], Response::HTTP_OK);
}

/**
* Check if ORCID is enabled in the current context
*/
private function isOrcidEnabled(): bool
{
$context = $this->getRequest()->getContext();
return OrcidManager::isEnabled($context);
}

/**
* Check if the current user has editor permissions
*/
private function hasEditorPermissions(int $publicationId): bool
{
$user = $this->getRequest()->getUser();
$context = $this->getRequest()->getContext();
$currentRoles = array_map(
function (Role $role) {
return $role->getId();
},
$user->getRoles($context->getId())
);

if (!array_intersect([Role::ROLE_ID_SITE_ADMIN, Role::ROLE_ID_MANAGER], $currentRoles)) {
$publicationId = $author->getData('publicationId');
$submissionId = Repo::publication()->get($publicationId)->getData('submissionId');
if (array_intersect([Role::ROLE_ID_SITE_ADMIN, Role::ROLE_ID_MANAGER], $currentRoles)) {
return true;
}

$submissionId = Repo::publication()->get($publicationId)->getData('submissionId');
$editorAssignment = StageAssignment::withSubmissionIds([$submissionId])
->withRoleIds([Role::ROLE_ID_SUB_EDITOR])
->withUserId($user->getId())
->first();

$editorAssignment = StageAssignment::withSubmissionIds([$submissionId])
->withRoleIds([Role::ROLE_ID_SUB_EDITOR])
->withUserId($user->getId())
->first();
return $editorAssignment !== null;
}

if ($editorAssignment === null) {
return response()->json([
'error' => __('api.orcid.403.editWithoutPermission'),
], Response::HTTP_FORBIDDEN);
}
/**
* Performs common validation logic for controller endpoints, return validated data or error information.
*
* @return array Returns an associative array containing either the validated data or error information
*/
private function validateRequest(Request $illuminateRequest): array
{
if (!$this->isOrcidEnabled()) {
return [
'error' => __('api.orcid.403.orcidNotEnabled'),
'status' => Response::HTTP_FORBIDDEN
];
}

$author->setOrcid(null);
$author->setOrcidVerified(false);
OrcidManager::removeOrcidAccessToken($author);
Repo::author()->edit($author, []);
$authorId = (int)$illuminateRequest->route('authorId');
$author = Repo::author()->get($authorId);

return response()->json([], Response::HTTP_OK);
if (empty($author)) {
return [
'error' => __('api.orcid.404.authorNotFound'),
'status' => Response::HTTP_NOT_FOUND
];
}

if (!$this->hasEditorPermissions($author->getData('publicationId'))) {
return [
'error' => __('api.orcid.403.editWithoutPermission'),
'status' => Response::HTTP_FORBIDDEN
];
}

return ['author' => $author];
}
}
8 changes: 4 additions & 4 deletions classes/orcid/OrcidManager.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ public static function isEnabled(?Context $context = null): bool
*/
public static function getOrcidUrl(?Context $context = null): string
{
$apiType = self::getApiType();
$apiType = self::getApiType($context);
return in_array($apiType, [self::API_PUBLIC_PRODUCTION, self::API_MEMBER_PRODUCTION]) ? self::ORCID_URL : self::ORCID_URL_SANDBOX;
}

Expand All @@ -112,7 +112,7 @@ public static function getOrcidUrl(?Context $context = null): string
*/
public static function getApiPath(?Context $context = null): string
{
$apiType = self::getApiType();
$apiType = self::getApiType($context);

return match ($apiType) {
self::API_PUBLIC_SANDBOX => self::ORCID_API_URL_PUBLIC_SANDBOX,
Expand All @@ -129,7 +129,7 @@ public static function getApiPath(?Context $context = null): string
*/
public static function isSandbox(?Context $context = null): bool
{
$apiType = self::getApiType();
$apiType = self::getApiType($context);
return in_array($apiType, [self::API_PUBLIC_SANDBOX, self::API_MEMBER_SANDBOX]);
}

Expand Down Expand Up @@ -208,7 +208,7 @@ public static function getCountry(?Context $context = null): string
*/
public static function isMemberApiEnabled(?Context $context = null): bool
{
$apiType = self::getApiType();
$apiType = self::getApiType($context);
return in_array($apiType, [self::API_MEMBER_PRODUCTION, self::API_MEMBER_SANDBOX]);
}

Expand Down
2 changes: 1 addition & 1 deletion jobs/orcid/DepositOrcidSubmission.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ public function __construct(
/**
* @inheritDoc
*/
public function handle()
public function handle(): void
{
// If the application is set to sandbox mode, it will not reach out to external services
if (Config::getVar('general', 'sandbox', false)) {
Expand Down
2 changes: 1 addition & 1 deletion jobs/orcid/RevokeOrcidToken.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ public function __construct(
/**
* @inheritDoc
*/
public function handle()
public function handle(): void
{
$token = $this->identity->getData('orcidAccessToken');
$httpClient = Application::get()->getHttpClient();
Expand Down
4 changes: 0 additions & 4 deletions jobs/orcid/SendAuthorMail.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,8 @@
namespace PKP\jobs\orcid;

use APP\author\Author;
use APP\core\Application;
use APP\facades\Repo;
use GuzzleHttp\Exception\ClientException;
use Illuminate\Support\Facades\Mail;
use PKP\config\Config;
use PKP\context\Context;
use PKP\jobs\BaseJob;
use PKP\mail\mailables\OrcidCollectAuthorId;
Expand All @@ -30,7 +27,6 @@

class SendAuthorMail extends BaseJob
{

public function __construct(
private Author $author,
private Context $context,
Expand Down