<?php
/**
* 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; under version 2
* of the License (non-upgradable).
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* Copyright (c) 2018 (original work) Open Assessment Technologies SA;
*
*/
namespace oat\taoLti\scripts\tools;
use oat\generis\model\GenerisRdf;
use oat\generis\model\OntologyAwareTrait;
use oat\generis\model\OntologyRdfs;
use oat\oatbox\extension\script\ScriptAction;
use oat\oatbox\log\LoggerAggregator;
use oat\oatbox\log\VerboseLoggerFactory;
use oat\taoLti\models\classes\ResourceLink\LinkService;
use oat\taoLti\models\classes\user\KvLtiUserService;
use oat\taoLti\models\classes\user\LtiUser;
use oat\taoLti\models\classes\user\LtiUserService;
use oat\taoLti\models\classes\user\OntologyLtiUserService;
/**
* Class OntologyLtiUserToKvMigration
*
* Script to migrate Ontology Lti users from ontology to key value persistence
* - Must have `--kv-persistence` option as KV persistence destination of migration
* - Overrides the LtiUserService config with KeyValue implementation if `--no-migrate-service` is not set
* - Delete Ontology data after migration if `--no-delete` is not set
*
* @package oat\taoLti\scripts\tools
*/
class OntologyLtiUserToKvMigration extends ScriptAction
{
use OntologyAwareTrait;
/**
* Run the migration
*/
protected function run()
{
try {
$this->setVerbosity();
/** @var LinkService $ontologyLinkService */
$ontologyLinkService = $this->getServiceLocator()->get(LtiUserService::SERVICE_ID);
if (!$ontologyLinkService instanceof OntologyLtiUserService) {
return new \common_report_Report(\common_report_Report::TYPE_ERROR, ' LtiUserService migration must be done on a Ontology Service e.q. OntologyLtiUserService.');
}
$userFactory = $this->getServiceLocator()->get(LtiUserService::SERVICE_ID)->getOption(LtiUserService::OPTION_FACTORY_LTI_USER);
$kvService = new KvLtiUserService([
KvLtiUserService::OPTION_PERSISTENCE => $this->getKeyValuePersistenceName(),
KvLtiUserService::OPTION_FACTORY_LTI_USER => $userFactory
]);
if ($this->getOption('no-migrate-service') !== true) {
$this->registerService(LtiUserService::SERVICE_ID, $kvService);
$this->logNotice('LtiUser service was set to KeyValue implementation.');
}
$class = $this->getClass(OntologyLtiUserService::CLASS_LTI_USER);
$iterator = new \core_kernel_classes_ResourceIterator($class);
$i = 0;
foreach ($iterator as $instance) {
$properties = $instance->getPropertiesValues([
OntologyLtiUserService::PROPERTY_USER_LTIKEY,
OntologyLtiUserService::PROPERTY_USER_LTICONSUMER,
GenerisRdf::PROPERTY_USER_UILG,
OntologyRdfs::RDFS_LABEL,
GenerisRdf::PROPERTY_USER_FIRSTNAME,
GenerisRdf::PROPERTY_USER_LASTNAME,
GenerisRdf::PROPERTY_USER_MAIL,
GenerisRdf::PROPERTY_USER_ROLES,
]);
$ltiKey = $this->getPropertyValue($properties, OntologyLtiUserService::PROPERTY_USER_LTIKEY);
$ltiConsumer = $this->getPropertyValue($properties, OntologyLtiUserService::PROPERTY_USER_LTICONSUMER);
$user = [
LtiUser::USER_IDENTIFIER => $instance->getUri(),
OntologyRdfs::RDFS_LABEL => $this->getPropertyValue($properties, OntologyRdfs::RDFS_LABEL),
GenerisRdf::PROPERTY_USER_ROLES => $this->getPropertyValue($properties, GenerisRdf::PROPERTY_USER_ROLES),
GenerisRdf::PROPERTY_USER_UILG => $this->getPropertyValue($properties, GenerisRdf::PROPERTY_USER_UILG),
GenerisRdf::PROPERTY_USER_FIRSTNAME => $this->getPropertyValue($properties, GenerisRdf::PROPERTY_USER_FIRSTNAME),
GenerisRdf::PROPERTY_USER_LASTNAME => $this->getPropertyValue($properties, GenerisRdf::PROPERTY_USER_LASTNAME),
GenerisRdf::PROPERTY_USER_MAIL => $this->getPropertyValue($properties, GenerisRdf::PROPERTY_USER_MAIL),
];
$kvPersistence = $this->getKeyValuePersistence();
$kvId = KvLtiUserService::LTI_USER . $ltiKey . $ltiConsumer;
if ($kvPersistence->set($kvId, json_encode($user))) {
$kvPersistence->set(KvLtiUserService::LTI_USER_LOOKUP . $instance->getUri(), $kvId);
if ($this->getOption('no-delete') !== true) {
$instance->delete();
$this->logInfo('LtiUser "' . $instance->getUri() . '" deleted from ontology storage.');
}
$this->logNotice('LtiUser "' . $instance->getUri() . '" successfully migrated.');
$i++;
} else {
$this->logError('LtiUser "' . $instance->getUri() . '" cannot be migrated.');
}
}
$this->logNotice('LtiUsers migrated: ' . $i);
} catch (\Exception $e) {
return \common_report_Report::createFailure('LtiUsers migration has failed with error message : ' . $e->getMessage());
}
return \common_report_Report::createSuccess('LtiUsers successfully has been migrated from Ontology to KV value. Count of LtiUsers migrated: ' . $i);
}
/**
* Extract a property value from $properties array
*
* @param array $properties
* @param $propertyName
* @return null|string
*/
protected function getPropertyValue(array $properties, $propertyName)
{
if (!isset($properties[$propertyName])) {
return null;
}
$value = reset($properties[$propertyName]);
return $value instanceof \core_kernel_classes_Resource ? $value->getUri() : (string) $value;
}
/**
* Get the persistence name from option
*
* @return string
* @throws \common_Exception
*/
protected function getKeyValuePersistenceName()
{
$this->getKeyValuePersistence();
return $this->getOption('kv-persistence');
}
/**
* Create the persistence from option and validate as KeyValue persistence
*
* @return \common_persistence_KeyValuePersistence
* @throws \common_Exception
*/
protected function getKeyValuePersistence()
{
$persistenceName = $this->getOption('kv-persistence');
/** @var \common_persistence_Manager $persistenceManager */
$persistenceManager = $this->getServiceLocator()->get(\common_persistence_Manager::SERVICE_ID);
$persistence = $persistenceManager->getPersistenceById($persistenceName);
if (!$persistence instanceof \common_persistence_KeyValuePersistence) {
throw new \common_Exception('Given persistence is not a key value');
}
return $persistence;
}
/**
* If verbose option is set, set the appropriate logger
*/
protected function setVerbosity()
{
if ($this->getOption('verbose') === true) {
// $verboseLogger = VerboseLoggerFactory::getInstance(['-nc', '-vvv']);
// $this->setLogger(new LoggerAggregator(array(
// $this->getLogger(),
// $verboseLogger
// )));
}
}
/**
* Provides option of script
*
* @return array
*/
protected function provideOptions()
{
return [
'kv-persistence' => [
'prefix' => 'kv',
'longPrefix' => 'kv-persistence',
'required' => true,
'description' => 'The KeyValue persistence where you want to migrate to.',
],
'no-migrate-service' => [
'prefix' => 'nms',
'longPrefix' => 'no-migrate-service',
'flag' => true,
'description' => 'Don\'t migrate the LtiUserService from ontology to key value.',
],
'no-delete' => [
'prefix' => 'nd',
'longPrefix' => 'no-delete',
'flag' => true,
'description' => 'Don\'t delete ontology LTI users after migration.',
],
'verbose' => [
'prefix' => 'v',
'longPrefix' => 'verbose',
'flag' => true,
'description' => 'Output the log as command output.',
],
];
}
/**
* Provides description of the script
*
* @return string
*/
protected function provideDescription()
{
return 'Migration script to migrate LTI users from Ontology to KeyValue persistence.';
}
/**
* Provides help of this script
*
* @return array
*/
protected function provideUsage()
{
return [
'prefix' => 'h',
'longPrefix' => 'help',
'description' => 'Prints the help.'
];
}
}