Multiple author affiliations

api/v1/rors/PKPRorController.php

@@ -0,0 +1,146 @@
+<?php
+/**
+ * @file api/v1/rors/PKPRorController.php
+ *
+ * Copyright (c) 2024 Simon Fraser University
+ * Copyright (c) 2024 John Willinsky
+ * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
+ *
+ * @class PKPRorController
+ *
+ * @ingroup api_v1_rors
+ *
+ * @brief Controller class to handle API requests for ror operations.
+ *
+ */
+
+namespace PKP\API\v1\rors;
+
+use APP\facades\Repo;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Http\Request;
+use Illuminate\Http\Response;
+use Illuminate\Support\Facades\Route;
+use PKP\core\PKPBaseController;
+use PKP\core\PKPRequest;
+use PKP\plugins\Hook;
+use PKP\security\authorization\ContextRequiredPolicy;
+use PKP\security\authorization\PolicySet;
+use PKP\security\authorization\RoleBasedHandlerOperationPolicy;
+use PKP\security\authorization\UserRolesRequiredPolicy;
+use PKP\security\Role;
+
+class PKPRorController extends PKPBaseController
+{
+    /** @var int The default number of rors to return in one request */
+    public const DEFAULT_COUNT = 30;
+
+    /** @var int The maximum number of rors to return in one request */
+    public const MAX_COUNT = 100;
+
+    /**
+     * @copydoc \PKP\core\PKPBaseController::getHandlerPath()
+     */
+    public function getHandlerPath(): string
+    {
+        return 'rors';
+    }
+
+    /**
+     * @copydoc \PKP\core\PKPBaseController::getRouteGroupMiddleware()
+     */
+    public function getRouteGroupMiddleware(): array
+    {
+        return [
+            'has.user',
+            'has.context',
+            self::roleAuthorizer([
+                Role::ROLE_ID_MANAGER,
+            ]),
+        ];
+    }
+
+    /**
+     * @copydoc \PKP\core\PKPBaseController::getGroupRoutes()
+     */
+    public function getGroupRoutes(): void
+    {
+        Route::get('{rorId}', $this->get(...))
+            ->name('ror.getRor')
+            ->whereNumber('rorId');
+
+        Route::get('', $this->getMany(...))
+            ->name('ror.getMany');
+    }
+
+    /**
+     * @copydoc \PKP\core\PKPBaseController::authorize()
+     */
+    public function authorize(PKPRequest $request, array &$args, array $roleAssignments): bool
+    {
+        $this->addPolicy(new UserRolesRequiredPolicy($request), true);
+
+        $rolePolicy = new PolicySet(PolicySet::COMBINING_PERMIT_OVERRIDES);
+
+        $this->addPolicy(new ContextRequiredPolicy($request));
+
+        foreach ($roleAssignments as $role => $operations) {
+            $rolePolicy->addPolicy(new RoleBasedHandlerOperationPolicy($request, $role, $operations));
+        }
+
+        $this->addPolicy($rolePolicy);
+
+        return parent::authorize($request, $args, $roleAssignments);
+    }
+
+    /**
+     * Get a single ror
+     */
+    public function get(Request $illuminateRequest): JsonResponse
+    {
+        if (!Repo::ror()->exists((int) $illuminateRequest->route('rorId'), $this->getRequest()->getContext()->getId())) {
+            return response()->json([
+                'error' => __('api.rors.404.rorNotFound')
+            ], Response::HTTP_OK);
+        }
+
+        $ror = Repo::ror()->get((int) $illuminateRequest->route('rorId'));
+
+        return response()->json(Repo::ror()->getSchemaMap()->map($ror), Response::HTTP_OK);
+    }
+
+    /**
+     * Get a collection of rors
+     *
+     * @hook API::rors::params [[$collector, $illuminateRequest]]
+     */
+    public function getMany(Request $illuminateRequest): JsonResponse
+    {
+        $collector = Repo::ror()->getCollector()
+            ->limit(self::DEFAULT_COUNT)
+            ->offset(0);
+
+        foreach ($illuminateRequest->query() as $param => $val) {
+            switch ($param) {
+                case 'count':
+                    $collector->limit(min((int) $val, self::MAX_COUNT));
+                    break;
+                case 'offset':
+                    $collector->offset((int) $val);
+                    break;
+                case 'searchPhrase':
+                    $collector->filterBySearchPhrase($val);
+                    break;
+            }
+        }
+
+        Hook::call('API::rors::params', [$collector, $illuminateRequest]);
+
+        $rors = $collector->getMany();
+
+        return response()->json([
+            'itemsMax' => $collector->getCount(),
+            'items' => Repo::ror()->getSchemaMap()->summarizeMany($rors->values())->values(),
+        ], Response::HTTP_OK);
+    }
+}

api/v1/submissions/PKPSubmissionController.php

@@ -3,8 +3,8 @@
 /**
  * @file api/v1/submissions/PKPSubmissionController.php
  *
- * Copyright (c) 2023 Simon Fraser University
- * Copyright (c) 2023 John Willinsky
+ * Copyright (c) 2023-2024 Simon Fraser University
+ * Copyright (c) 2023-2024 John Willinsky
  * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
  *
  * @class PKPSubmissionController
@@ -666,7 +666,7 @@ public function add(Request $illuminateRequest): JsonResponse
 
         // Create an author record from the submitter's user account
         if ($submitAsUserGroup->getRoleId() === Role::ROLE_ID_AUTHOR) {
-            $author = Repo::author()->newAuthorFromUser($request->getUser());
+            $author = Repo::author()->newAuthorFromUser($request->getUser(), $submission->getDefaultLocale());
             $author->setData('publicationId', $publication->getId());
             $author->setUserGroupId($submitAsUserGroup->getId());
             $authorId = Repo::author()->add($author);

classes/affiliation/Affiliation.php

@@ -0,0 +1,47 @@
+<?php
+/**
+ * @file classes/affiliation/Affiliation.php
+ *
+ * Copyright (c) 2024 Simon Fraser University
+ * Copyright (c) 2024 John Willinsky
+ * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
+ *
+ * @class Affiliation
+ *
+ * @ingroup affiliation
+ *
+ * @see DAO
+ *
+ * @brief Basic class describing a affiliation.
+ */
+
+namespace PKP\affiliation;
+
+use PKP\core\DataObject;
+
+class Affiliation extends DataObject
+{
+    /**
+     * Get author id
+     */
+    public function getAuthorId()
+    {
+        return $this->getData('authorId');
+    }
+
+    /**
+     * Get the ROR
+     *
+     * @return string|null
+     */
+    public function getROR(): ?string
+    {
+        return $this->getData('ror');
+    }
+
+    /** @copydoc DataObject::getLocalizedGivenName() */
+    public function getLocalizedName(): mixed
+    {
+        return $this->getLocalizedData('name');
+    }
+}

classes/affiliation/Collector.php

@@ -0,0 +1,155 @@
+<?php
+/**
+ * @file classes/affiliation/Collector.php
+ *
+ * Copyright (c) 2024 Simon Fraser University
+ * Copyright (c) 2024 John Willinsky
+ * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
+ *
+ * @class Collector
+ *
+ * @brief A helper class to configure a Query Builder to get a collection of rors
+ */
+
+namespace PKP\affiliation;
+
+use Illuminate\Database\Query\Builder;
+use Illuminate\Support\Collection;
+use Illuminate\Support\Facades\DB;
+use Illuminate\Support\LazyCollection;
+use PKP\core\interfaces\CollectorInterface;
+use PKP\plugins\Hook;
+
+/**
+ * @template T of Affiliation
+ */
+class Collector implements CollectorInterface
+{
+    /** @var DAO */
+    public DAO $dao;
+
+    public ?int $count = null;
+
+    public ?int $offset = null;
+
+    /** @var int[]|null */
+    public ?array $authorIds = null;
+
+    /** Get affiliations with a name */
+    public ?string $name = null;
+
+    public ?string $searchPhrase = null;
+
+    public function __construct(DAO $dao)
+    {
+        $this->dao = $dao;
+    }
+
+    public function getCount(): int
+    {
+        return $this->dao->getCount($this);
+    }
+
+    /**
+     * @return Collection<int,int>
+     */
+    public function getIds(): Collection
+    {
+        return $this->dao->getIds($this);
+    }
+
+    /**
+     * @copydoc DAO::getMany()
+     *
+     * @return LazyCollection<int,T>
+     */
+    public function getMany(): LazyCollection
+    {
+        return $this->dao->getMany($this);
+    }
+
+    /**
+     * Filter by authors
+     */
+    public function filterByAuthorIds(?array $authorIds): self
+    {
+        $this->authorIds = $authorIds;
+        return $this;
+    }
+
+    /**
+     * Filter by affiliation name.
+     *
+     * @param string|null $name
+     *
+     * @return $this
+     */
+    public function filterByName(?string $name): self
+    {
+        $this->name = $name;
+        return $this;
+    }
+
+    /**
+     * Filter rors by those matching a search query
+     */
+    public function searchPhrase(?string $phrase): self
+    {
+        $this->searchPhrase = $phrase;
+        return $this;
+    }
+
+    /**
+     * Limit the number of objects retrieved
+     */
+    public function limit(?int $count): self
+    {
+        $this->count = $count;
+        return $this;
+    }
+
+    /**
+     * Offset the number of objects retrieved, for example to
+     * retrieve the second page of contents
+     */
+    public function offset(?int $offset): self
+    {
+        $this->offset = $offset;
+        return $this;
+    }
+
+    /**
+     * @copydoc CollectorInterface::getQueryBuilder()
+     */
+    public function getQueryBuilder(): Builder
+    {
+        $qb = DB::table($this->dao->table . ' as a')
+            ->select('a.*');
+
+        if (!is_null($this->count)) {
+            $qb->limit($this->count);
+        }
+
+        if (!is_null($this->offset)) {
+            $qb->offset($this->offset);
+        }
+
+        if (!is_null($this->authorIds)) {
+            $qb->whereIn('a.author_id', $this->authorIds);
+        }
+
+        $qb->when($this->name !== null, function (Builder $qb) {
+            $qb->whereIn('a.author_affiliation_id', function (Builder $qb) {
+                $qb->select('author_affiliation_id')
+                    ->from($this->dao->settingsTable)
+                    ->where('setting_name', '=', 'name')
+                    ->where('setting_value', $this->name);
+            });
+        });
+
+        // Add app-specific query statements
+        Hook::call('Affiliation::Collector', [&$qb, $this]);
+
+        return $qb;
+    }
+}