Skip to content

Add option of configuring additional scopes for PAIA #4945

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

Open
demiankatz wants to merge 3 commits into
base: dev
Choose a base branch
from
+16 −0
Open

Add option of configuring additional scopes for PAIA #4945

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dc5faf8
Implemented the option of configuring additionals scopes for the PAIA…
Willy8-Dev Feb 28, 2025
acfdfe6
Update module/VuFind/src/VuFind/ILS/Driver/PAIA.php
Willy8-Dev Mar 3, 2025
42448d5
php-cs-fixer
demiankatz Dec 8, 2025
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
10 changes: 10 additions & 0 deletions config/vufind/PAIA.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,16 @@ baseUrl = ""
;accountBlockNotificationsForMissingScopes[read_notifications] = "ILSMessages::no_read_notifications_scope"
;accountBlockNotificationsForMissingScopes[delete_notifications] = "ILSMessages::no_delete_notifications_scope"

; Define additional scope constants from VuFind/ILS/Driver/PAIA.php for use here.
; Basic scopes that are used (see function paiaLogin):
; SCOPE_READ_PATRON, SCOPE_READ_FEES, SCOPE_READ_ITEM, SCOPE_WRITE_ITEMS, SCOPE_CHANGE_PASSWORD
; additionalScopes[] = SCOPE_UPDATE_PATRON
; additionalScopes[] = SCOPE_UPDATE_PATRON_NAME
; additionalScopes[] = SCOPE_UPDATE_PATRON_EMAIL
; additionalScopes[] = SCOPE_UPDATE_PATRON_ADDRESS
; additionalScopes[] = SCOPE_READ_NOTIFICATIONS
; additionalScopes[] = SCOPE_DELETE_NOTIFICATIONS

; A PAIA auth server acts as OAuth authorization server (RFC 6749) with
; password credentials grant, as defined in section 4.3 of OAuth specification,
; and/or client credentials grant, as defined in section 4.4 of the OAuth
Expand Down
6 changes: 6 additions & 0 deletions module/VuFind/src/VuFind/ILS/Driver/PAIA.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
use VuFind\Exception\Forbidden as ForbiddenException;
use VuFind\Exception\ILS as ILSException;

use function constant;
use function count;
use function in_array;
use function is_array;
Expand Down Expand Up @@ -1873,6 +1874,11 @@ protected function paiaLogin($username, $password)
self::SCOPE_WRITE_ITEMS . ' ' .
self::SCOPE_CHANGE_PASSWORD;

// append additional scopes via config
foreach ((array)($this->config['PAIA']['additionalScopes'] ?? []) as $scope) {
$post_data['scope'] .= ' ' . constant("self::$scope");
}

// perform full PAIA auth and get patron info
$result = $this->httpService->post(
$this->paiaURL . 'auth/login',
Expand Down