oai-pmh2/src/Middleware/Identify.php

103 lines
3.3 KiB
PHP
Raw Normal View History

2024-01-03 16:54:13 +01:00
<?php
/**
* OAI-PMH 2.0 Data Provider
2024-01-22 15:06:07 +01:00
* Copyright (C) 2024 Sebastian Meyer <sebastian.meyer@opencultureconsulting.com>
2024-01-03 16:54:13 +01:00
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
2024-01-22 15:06:07 +01:00
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
2024-01-03 16:54:13 +01:00
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
2024-01-22 15:06:07 +01:00
* along with this program. If not, see <http://www.gnu.org/licenses/>.
2024-01-03 16:54:13 +01:00
*/
declare(strict_types=1);
namespace OCC\OaiPmh2\Middleware;
use GuzzleHttp\Psr7\Uri;
use OCC\OaiPmh2\Configuration;
use OCC\OaiPmh2\Middleware;
2024-09-30 19:37:29 +02:00
use OCC\OaiPmh2\Response;
2024-01-03 16:54:13 +01:00
use Psr\Http\Message\ServerRequestInterface;
/**
* Process the "Identify" request.
2024-09-30 19:37:29 +02:00
*
2024-01-03 16:54:13 +01:00
* @see https://www.openarchives.org/OAI/openarchivesprotocol.html#Identify
*
* @author Sebastian Meyer <sebastian.meyer@opencultureconsulting.com>
2024-07-13 18:49:54 +02:00
* @package OAIPMH2
2024-01-03 16:54:13 +01:00
*/
class Identify extends Middleware
{
/**
* Prepare the response body for verb "Identify".
*
* @param ServerRequestInterface $request The incoming request
*
* @return void
*/
protected function prepareResponse(ServerRequestInterface $request): void
{
2024-10-14 14:51:42 +02:00
$response = new Response($request);
$identify = $response->createElement('Identify', '', true);
2024-01-03 16:54:13 +01:00
2024-09-30 19:37:29 +02:00
$repositoryName = $response->createElement(
2024-10-14 14:51:42 +02:00
'repositoryName',
Configuration::getInstance()->repositoryName
2024-09-30 19:37:29 +02:00
);
2024-10-14 14:51:42 +02:00
$identify->appendChild($repositoryName);
2024-01-03 16:54:13 +01:00
$uri = Uri::composeComponents(
2024-10-14 14:51:42 +02:00
$request->getUri()->getScheme(),
$request->getUri()->getAuthority(),
$request->getUri()->getPath(),
null,
null
2024-09-30 19:37:29 +02:00
);
2024-10-14 14:51:42 +02:00
$baseURL = $response->createElement('baseURL', $uri);
$identify->appendChild($baseURL);
2024-01-03 16:54:13 +01:00
2024-10-14 14:51:42 +02:00
$protocolVersion = $response->createElement('protocolVersion', '2.0');
$identify->appendChild($protocolVersion);
2024-01-03 16:54:13 +01:00
2024-09-30 19:37:29 +02:00
$adminEmail = $response->createElement(
2024-10-14 14:51:42 +02:00
'adminEmail',
Configuration::getInstance()->adminEmail
2024-09-30 19:37:29 +02:00
);
2024-10-14 14:51:42 +02:00
$identify->appendChild($adminEmail);
2024-01-03 16:54:13 +01:00
2024-09-30 19:37:29 +02:00
$earliestDatestamp = $response->createElement(
2024-10-14 14:51:42 +02:00
'earliestDatestamp',
$this->em->getEarliestDatestamp()
2024-09-30 19:37:29 +02:00
);
2024-10-14 14:51:42 +02:00
$identify->appendChild($earliestDatestamp);
2024-01-03 16:54:13 +01:00
2024-09-30 19:37:29 +02:00
$deletedRecord = $response->createElement(
2024-10-14 14:51:42 +02:00
'deletedRecord',
Configuration::getInstance()->deletedRecords
2024-09-30 19:37:29 +02:00
);
2024-10-14 14:51:42 +02:00
$identify->appendChild($deletedRecord);
2024-01-03 16:54:13 +01:00
2024-10-14 14:51:42 +02:00
$granularity = $response->createElement('granularity', 'YYYY-MM-DDThh:mm:ssZ');
$identify->appendChild($granularity);
2024-01-03 16:54:13 +01:00
2024-01-06 21:15:11 +01:00
// TODO: Implement explicit content compression support.
2024-10-14 14:51:42 +02:00
// $compressionDeflate = $response->createElement('compression', 'deflate');
// $identify->appendChild($compressionDeflate);
2024-01-06 21:15:11 +01:00
2024-10-14 14:51:42 +02:00
// $compressionGzip = $response->createElement('compression', 'gzip');
// $identify->appendChild($compressionGzip);
2024-01-03 16:54:13 +01:00
2024-09-30 19:37:29 +02:00
$this->preparedResponse = $response;
2024-01-03 16:54:13 +01:00
}
}