484 lines
37 KiB
PHP
484 lines
37 KiB
PHP
|
<?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) 2002-2008 (original work) Public Research Centre Henri Tudor & University of Luxembourg (under the project TAO & TAO2);
|
||
|
|
* 2008-2010 (update and modification) Deutsche Institut für Internationale Pädagogische Forschung (under the project TAO-TRANSFER);
|
||
|
|
* 2009-2012 (update and modification) Public Research Centre Henri Tudor (under the project TAO-SUSTAIN & TAO-DEV);
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
|
||
|
|
use oat\generis\model\GenerisRdf;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This Script class aims at providing tools to manage TAO extensions.
|
||
|
|
*
|
||
|
|
* @access public
|
||
|
|
* @author Jerome Bogaerts, <jerome.bogaerts@tudor.lu>
|
||
|
|
* @package tao
|
||
|
|
|
||
|
|
*/
|
||
|
|
class tao_scripts_TaoHardify extends tao_scripts_Runner
|
||
|
|
{
|
||
|
|
// --- ASSOCIATIONS ---
|
||
|
|
|
||
|
|
|
||
|
|
// --- ATTRIBUTES ---
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The current action the TaoExtensions Script class is running. It
|
||
|
|
* to the 'action' parameter given in input.
|
||
|
|
*
|
||
|
|
* @access public
|
||
|
|
* @var string
|
||
|
|
*/
|
||
|
|
public $currentAction = '';
|
||
|
|
/**
|
||
|
|
* Contains the final values of the CLI parameters given as input for this
|
||
|
|
* (merge of the default values and paraleters array).
|
||
|
|
*
|
||
|
|
* @access public
|
||
|
|
* @var array
|
||
|
|
*/
|
||
|
|
public $options = [];
|
||
|
|
/**
|
||
|
|
* States if the Generis user is connected or not.
|
||
|
|
*
|
||
|
|
* @access public
|
||
|
|
* @var boolean
|
||
|
|
*/
|
||
|
|
public $connected = false;
|
||
|
|
// --- OPERATIONS ---
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Instructions to execute before the run method.
|
||
|
|
*
|
||
|
|
* @access public
|
||
|
|
* @author Jerome Bogaerts, <jerome.bogaerts@tudor.lu>
|
||
|
|
* @return void
|
||
|
|
*/
|
||
|
|
public function preRun()
|
||
|
|
{
|
||
|
|
$this->checkInput();
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Instructions to execute to handle the action to perform.
|
||
|
|
*
|
||
|
|
* @access public
|
||
|
|
* @author Jerome Bogaerts, <jerome.bogaerts@tudor.lu>
|
||
|
|
* @return void
|
||
|
|
*/
|
||
|
|
public function run()
|
||
|
|
{
|
||
|
|
$this->outVerbose("Connecting...");
|
||
|
|
if ($this->connect($this->options['user'], $this->options['password'])) {
|
||
|
|
$this->outVerbose("Connected to TAO API.");
|
||
|
|
switch ($this->options['action']) {
|
||
|
|
case 'hardify':
|
||
|
|
$this->setCurrentAction($this->options['action']);
|
||
|
|
$this->actionHardify();
|
||
|
|
|
||
|
|
break;
|
||
|
|
case 'unhardify':
|
||
|
|
$this->setCurrentAction($this->options['action']);
|
||
|
|
$this->actionUnhardify();
|
||
|
|
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->disconnect();
|
||
|
|
} else {
|
||
|
|
$this->error("Could not connect to TAO API. Please check your user name and password.", true);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Instructions to execute after the postRun method.
|
||
|
|
*
|
||
|
|
* @access public
|
||
|
|
* @author Jerome Bogaerts, <jerome.bogaerts@tudor.lu>
|
||
|
|
* @return void
|
||
|
|
*/
|
||
|
|
public function postRun()
|
||
|
|
{
|
||
|
|
$this->outVerbose("Script executed gracefully.");
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Checks the input parameters when the script is called from the CLI. It
|
||
|
|
* check parameters common to any action (user, password, action) and
|
||
|
|
* to the appropriate checking method for the other parameters.
|
||
|
|
*
|
||
|
|
* @access public
|
||
|
|
* @author Jerome Bogaerts, <jerome.bogaerts@tudor.lu>
|
||
|
|
* @return void
|
||
|
|
*/
|
||
|
|
public function checkInput()
|
||
|
|
{
|
||
|
|
$this->options = ['verbose' => false,
|
||
|
|
'action' => null,
|
||
|
|
'user' => null,
|
||
|
|
'password' => null];
|
||
|
|
$this->options = array_merge($this->options, $this->parameters);
|
||
|
|
// Check common inputs.
|
||
|
|
if ($this->options['user'] == null) {
|
||
|
|
$this->error("Please provide a Generis 'user'.", true);
|
||
|
|
} else {
|
||
|
|
if ($this->options['password'] == null) {
|
||
|
|
$this->error("Please provide a Generis 'password'.", true);
|
||
|
|
} else {
|
||
|
|
if ($this->options['action'] == null) {
|
||
|
|
$this->error("Please provide the 'action' parameter.", true);
|
||
|
|
} else {
|
||
|
|
switch ($this->options['action']) {
|
||
|
|
case 'hardify':
|
||
|
|
|
||
|
|
|
||
|
|
break;
|
||
|
|
case 'unhardify':
|
||
|
|
|
||
|
|
|
||
|
|
break;
|
||
|
|
default:
|
||
|
|
|
||
|
|
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the current action being executed.
|
||
|
|
*
|
||
|
|
* @access protected
|
||
|
|
* @author Jerome Bogaerts, <jerome.bogaerts@tudor.lu>
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
protected function getCurrentAction()
|
||
|
|
{
|
||
|
|
return $this->currentAction;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Set the current action being executed.
|
||
|
|
*
|
||
|
|
* @access public
|
||
|
|
* @author Jerome Bogaerts, <jerome.bogaerts@tudor.lu>
|
||
|
|
* @param string currentAction The name of the current action being executed by the script.
|
||
|
|
* @return void
|
||
|
|
*/
|
||
|
|
public function setCurrentAction($currentAction)
|
||
|
|
{
|
||
|
|
$this->currentAction = $currentAction;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Hardify a class.
|
||
|
|
*
|
||
|
|
* @access public
|
||
|
|
* @author Jerome Bogaerts, <jerome.bogaerts@tudor.lu>
|
||
|
|
* @return void
|
||
|
|
*/
|
||
|
|
public function actionHardify()
|
||
|
|
{
|
||
|
|
|
||
|
|
// Retrieve parameter values.
|
||
|
|
$class = $this->options['class'];
|
||
|
|
$topClass = $this->options['topClass'];
|
||
|
|
$createForeigns = $this->options['createForeigns'];
|
||
|
|
$recursive = $this->options['recursive'];
|
||
|
|
$classUri = $class->getUri();
|
||
|
|
$additionalProperties = [];
|
||
|
|
$blackList = ['http://www.tao.lu/middleware/wfEngine.rdf#ClassProcessVariables'];
|
||
|
|
if (!empty($this->options['additionalProperties'])) {
|
||
|
|
$additionalProperties = $this->options['additionalProperties'];
|
||
|
|
}
|
||
|
|
|
||
|
|
$optionsHardify = ['recursive' => $recursive,
|
||
|
|
'append' => true,
|
||
|
|
'createForeigns' => $createForeigns,
|
||
|
|
'referencesAllTypes' => true,
|
||
|
|
'rmSources' => true,
|
||
|
|
'topClass' => $topClass,
|
||
|
|
'additionalProperties' => $additionalProperties];
|
||
|
|
try {
|
||
|
|
$this->outVerbose("Hardifying class '${classUri}'...");
|
||
|
|
$switcher = new core_kernel_persistence_Switcher($blackList);
|
||
|
|
$switcher->hardify($class, $optionsHardify);
|
||
|
|
|
||
|
|
$hardenedClasses = $switcher->getHardenedClasses();
|
||
|
|
if (array_key_exists($classUri, $hardenedClasses)) {
|
||
|
|
$count = $hardenedClasses[$classUri];
|
||
|
|
$this->outVerbose("Class '${classUri}' successfully hardified: ${count} instance(s) compiled.");
|
||
|
|
|
||
|
|
if (true == $optionsHardify['createForeigns']) {
|
||
|
|
unset($hardenedClasses[$classUri]);
|
||
|
|
|
||
|
|
if (true == empty($hardenedClasses)) {
|
||
|
|
$this->outVerbose("No foreign classes were compiled.");
|
||
|
|
} else {
|
||
|
|
foreach ($hardenedClasses as $uri => $count) {
|
||
|
|
$this->outVerbose("Foreign class '${uri} successfully hardified: ${count} instance(s) compiled.'");
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
} catch (Exception $e) {
|
||
|
|
$msg = "A fatal error occured while hardifying class '${classUri}': " . $e->getMessage();
|
||
|
|
$this->error($msg, true);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Create a new instance of the TaoExtensions script and executes it. If the
|
||
|
|
* inputFormat parameter is not provided, the script configures itself
|
||
|
|
* to foster code reuse.
|
||
|
|
*
|
||
|
|
* @access public
|
||
|
|
* @author Jerome Bogaerts, <jerome.bogaerts@tudor.lu>
|
||
|
|
* @param array inputFormat
|
||
|
|
* @param array options
|
||
|
|
* @return mixed
|
||
|
|
*/
|
||
|
|
public function __construct($inputFormat = [], $options = [])
|
||
|
|
{
|
||
|
|
if (count($inputFormat) == 0) {
|
||
|
|
// Autoconfigure the script.
|
||
|
|
$inputFormat = ['min' => 4,
|
||
|
|
'parameters' => [
|
||
|
|
['name' => 'verbose',
|
||
|
|
'type' => 'boolean',
|
||
|
|
'shortcut' => 'v',
|
||
|
|
'description' => 'Verbose mode (default = false)'
|
||
|
|
],
|
||
|
|
['name' => 'user',
|
||
|
|
'type' => 'string',
|
||
|
|
'shortcut' => 'u',
|
||
|
|
'description' => 'Generis user (must be a TAO Manager)'
|
||
|
|
],
|
||
|
|
['name' => 'password',
|
||
|
|
'type' => 'string',
|
||
|
|
'shortcut' => 'p',
|
||
|
|
'description' => 'Generis password'
|
||
|
|
],
|
||
|
|
['name' => 'action',
|
||
|
|
'type' => 'string',
|
||
|
|
'shortcut' => 'a',
|
||
|
|
'description' => 'Action to perform'
|
||
|
|
],
|
||
|
|
['name' => 'class',
|
||
|
|
'type' => 'string',
|
||
|
|
'shortcut' => 'c',
|
||
|
|
'description' => 'Class to hardify/unhardify'
|
||
|
|
],
|
||
|
|
['name' => 'additionalProperties',
|
||
|
|
'type' => 'string',
|
||
|
|
'shortcut' => 'aP',
|
||
|
|
'description' => 'Additional properties to be compiled with the class, separated by commas (",").'
|
||
|
|
],
|
||
|
|
['name' => 'createForeigns',
|
||
|
|
'type' => 'boolean',
|
||
|
|
'shortcut' => 'cF',
|
||
|
|
'description' => 'Create foreign classes (default = false).'
|
||
|
|
],
|
||
|
|
['name' => 'topClass',
|
||
|
|
'type' => 'string',
|
||
|
|
'shortcut' => 'tC',
|
||
|
|
'description' => 'The class where to stop in the class hierarchy hardification (default = rdfs:Resource).'
|
||
|
|
],
|
||
|
|
['name' => 'recursive',
|
||
|
|
'type' => 'boolean',
|
||
|
|
'shortcut' => 'r',
|
||
|
|
'description' => 'Hardify subclasses of the class to hardify or not (default = false).'
|
||
|
|
],
|
||
|
|
]];
|
||
|
|
}
|
||
|
|
|
||
|
|
parent::__construct($inputFormat, $options);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Check additional inputs for the 'setConfig' action.
|
||
|
|
*
|
||
|
|
* @access public
|
||
|
|
* @author Jerome Bogaerts, <jerome.bogaerts@tudor.lu>
|
||
|
|
* @return void
|
||
|
|
*/
|
||
|
|
public function checkHardifyInput()
|
||
|
|
{
|
||
|
|
$defaults = ['class' => null,
|
||
|
|
'createForeigns' => false,
|
||
|
|
'recursive' => false,
|
||
|
|
'additionalProperties' => null,
|
||
|
|
'topClass' => null];
|
||
|
|
$this->options = array_merge($defaults, $this->options);
|
||
|
|
if (empty($this->options['class'])) {
|
||
|
|
$this->error("Please provide the 'class' parameter.", true);
|
||
|
|
} else {
|
||
|
|
$classUri = trim($this->options['class']);
|
||
|
|
if (common_Utils::isUri($classUri)) {
|
||
|
|
// We are OK with the class to Hardify
|
||
|
|
$class = new core_kernel_classes_Class($classUri);
|
||
|
|
$this->options['class'] = $class;
|
||
|
|
|
||
|
|
if (!empty($this->options['additionalProperties'])) {
|
||
|
|
$additionalProperties = explode(',', $this->options['additionalProperties']);
|
||
|
|
if (empty($additionalProperties)) {
|
||
|
|
$this->error("The 'additionalProperties' parameter value is invalid.", true);
|
||
|
|
} else {
|
||
|
|
foreach ($additionalProperties as $k => $aP) {
|
||
|
|
$uri = trim($aP);
|
||
|
|
if (true == common_Utils::isUri($uri)) {
|
||
|
|
// store clean uri.
|
||
|
|
$additionalProperties[$k] = new core_kernel_classes_Property($uri);
|
||
|
|
} else {
|
||
|
|
$this->error("'${uri}' is not a valid URI in 'additionalProperties'.", true);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->options['additionalProperties'] = $additionalProperties;
|
||
|
|
|
||
|
|
if ($this->options['topClass'] == null) {
|
||
|
|
$this->options['topClass'] = new core_kernel_classes_Class(GenerisRdf::CLASS_GENERIS_RESOURCE);
|
||
|
|
} else {
|
||
|
|
$topClassUri = trim($this->options['topClass']);
|
||
|
|
if (true == common_Utils::isUri($topClassUri)) {
|
||
|
|
$this->options['topClass'] = new core_kernel_classes_Class($topClassUri);
|
||
|
|
} else {
|
||
|
|
$this->error("'${topClassUri}' is not a valid URI in 'topClass'.", true);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
} else {
|
||
|
|
$this->error("The 'class' parameter value is not a valid URI.", true);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Set the connected attribute to a given value.
|
||
|
|
*
|
||
|
|
* @access public
|
||
|
|
* @author Jerome Bogaerts, <jerome.bogaerts@tudor.lu>
|
||
|
|
* @param boolean value true if the user is connected, otherwhise false.
|
||
|
|
* @return void
|
||
|
|
*/
|
||
|
|
public function setConnected($value)
|
||
|
|
{
|
||
|
|
$this->connected = $value;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Short description of method isConnected
|
||
|
|
*
|
||
|
|
* @access public
|
||
|
|
* @author Jerome Bogaerts, <jerome.bogaerts@tudor.lu>
|
||
|
|
* @return boolean
|
||
|
|
*/
|
||
|
|
public function isConnected()
|
||
|
|
{
|
||
|
|
return (bool) $this->connected;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Display an error message. If the stopExec parameter is set to true, the
|
||
|
|
* of the script stops and the currently connected user is disconnected if
|
||
|
|
* It overrides the Runner::err method for this purpose.
|
||
|
|
*
|
||
|
|
* @access public
|
||
|
|
* @author Jerome Bogaerts, <jerome.bogaerts@tudor.lu>
|
||
|
|
* @param string message The error message to display.
|
||
|
|
* @param boolean stopExec If set to false, the execution of the script stops.
|
||
|
|
* @return mixed
|
||
|
|
*/
|
||
|
|
public function error($message, $stopExec = false)
|
||
|
|
{
|
||
|
|
if ($stopExec == true) {
|
||
|
|
$this->disconnect();
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->err($message, $stopExec);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Connect to the generis API by using the CLI arguments 'user' and
|
||
|
|
* It returns true or false depending on the connection establishement.
|
||
|
|
*
|
||
|
|
* @access public
|
||
|
|
* @author Jerome Bogaerts, <jerome.bogaerts@tudor.lu>
|
||
|
|
* @param string user
|
||
|
|
* @param string password
|
||
|
|
* @return boolean
|
||
|
|
*/
|
||
|
|
public function connect($user, $password)
|
||
|
|
{
|
||
|
|
$returnValue = (bool) false;
|
||
|
|
$userService = tao_models_classes_UserService::singleton();
|
||
|
|
$returnValue = $userService->loginUser($user, $password);
|
||
|
|
$this->setConnected($returnValue);
|
||
|
|
return (bool) $returnValue;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Disconnect the currently connected user.
|
||
|
|
*
|
||
|
|
* @access public
|
||
|
|
* @author Jerome Bogaerts, <jerome.bogaerts@tudor.lu>
|
||
|
|
* @return mixed
|
||
|
|
*/
|
||
|
|
public function disconnect()
|
||
|
|
{
|
||
|
|
if ($this->isConnected()) {
|
||
|
|
$this->outVerbose("Disconnecting user...");
|
||
|
|
$userService = tao_models_classes_UserService::singleton();
|
||
|
|
if ($userService->logout() == true) {
|
||
|
|
$this->outVerbose("User gracefully disconnected from TAO API.");
|
||
|
|
$this->setConnected(false);
|
||
|
|
} else {
|
||
|
|
$this->error("User could not be disconnected from TAO API.");
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Short description of method actionInstall
|
||
|
|
*
|
||
|
|
* @access public
|
||
|
|
* @author Jerome Bogaerts, <jerome.bogaerts@tudor.lu>
|
||
|
|
* @return void
|
||
|
|
*/
|
||
|
|
public function actionUnhardify()
|
||
|
|
{
|
||
|
|
$this->error("Not yet implemented.", true);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Short description of method checkInstallInput
|
||
|
|
*
|
||
|
|
* @access public
|
||
|
|
* @author Jerome Bogaerts, <jerome.bogaerts@tudor.lu>
|
||
|
|
* @return void
|
||
|
|
*/
|
||
|
|
public function checkUnhardifyInput()
|
||
|
|
{
|
||
|
|
$this->error("Not yet implemented.", true);
|
||
|
|
}
|
||
|
|
}
|