/**
* Display a list of versions for a tool
*
* @return void
*/
public function versionsTask()
{
$this->view->setLayout('versions');
if (!$this->_toolid) {
$this->_toolid = Request::getInt('toolid', 0);
}
// Create a Tool object
$obj = new \Components\Tools\Tables\Tool($this->database);
// do we have an alias?
if ($this->_toolid == 0) {
if ($alias = Request::getVar('app', '')) {
$this->_toolid = $obj->getToolId($alias);
}
}
// Couldn't get ID, exit
if (!$this->_toolid) {
App::redirect(Route::url('index.php?option=' . $this->_option . '&controller=' . $this->_controller));
return;
}
// get vars
if (!$this->_action) {
$this->_action = Request::getVar('action', 'dev');
}
if (!$this->_error) {
$this->_error = Request::getVar('error', '');
}
// check access rights
if (!$this->_checkAccess($this->_toolid)) {
App::abort(403, Lang::txt('COM_TOOLS_ALERTNOTAUTH'));
return;
}
// Create a Tool Version object
$objV = new \Components\Tools\Tables\Version($this->database);
$objV->getToolVersions($this->_toolid, $versions, '');
// Set the page title
$this->view->title = Lang::txt(strtoupper($this->_option)) . ': ';
$this->view->title .= $this->_action == 'confirm' ? Lang::txt('COM_TOOLS_CONTRIBTOOL_APPROVE_TOOL') : Lang::txt('COM_TOOLS_TASK_VERSIONS');
Document::setTitle($this->view->title);
$hzt = \Components\Tools\Models\Tool::getInstance($this->_toolid);
$hztv_dev = $hzt->getRevision('development');
$hztv_current = $hzt->getRevision('current');
$this->view->status = array('toolid' => $hzt->id, 'published' => $hzt->published, 'version' => $hztv_dev->version, 'state' => $hzt->state, 'toolname' => $hzt->toolname, 'membergroups' => \Components\Tools\Models\Tool::getToolGroups($this->_toolid), 'resourceid' => \Components\Tools\Models\Tool::getResourceId($this->_toolid), 'currentrevision' => is_object($hztv_current) ? $hztv_current->revision : '', 'currentversion' => is_object($hztv_current) ? $hztv_current->version : '');
if (Pathway::count() <= 0) {
Pathway::append(Lang::txt(strtoupper($this->_option)), 'index.php?option=' . $this->_option);
}
Pathway::append(Lang::txt('COM_TOOLS_STATUS') . ' ' . Lang::txt('COM_TOOLS_FOR') . ' ' . $this->view->status['toolname'], 'index.php?option=' . $this->_option . '&controller=' . $this->_controller . 'task=status&app=' . $this->view->status['toolname']);
if ($this->_action != 'confirm') {
Pathway::append(Lang::txt('COM_TOOLS_TASK_VERSIONS'), 'index.php?option=' . $this->_option . '&controller=' . $this->_controller . '&task=versions&app=' . $this->view->status['toolname']);
}
$this->view->admin = $this->config->get('access-admin-component');
$this->view->error = $this->_error;
$this->view->action = $this->_action;
$this->view->versions = $versions;
foreach ($this->getErrors() as $error) {
$this->view->setError($error);
}
$this->view->display();
}
/**
* Get a list of parents of this resource
* Accepts either a numeric array index
* If index, it'll return the entry matching that index in the list
*
* @param mixed $idx Index value
* @return array
*/
public function revisions($idx = null)
{
if (!$this->exists()) {
return array();
}
if (!isset($this->revisions)) {
$this->revisions = array();
$alltools = array();
$tv = new \Components\Tools\Tables\Version($this->_db);
$tv->getToolVersions('', $alltools, $this->resource->alias);
if ($alltools) {
$this->revisions = $alltools;
}
}
if ($idx !== null && is_numeric($idx)) {
if (isset($this->revisions[$idx])) {
return $this->revisions[$idx];
} else {
if (is_string($idx)) {
switch (strtolower($idx)) {
case 'current':
$curtool = null;
foreach ($this->revisions as $tool) {
// Current version
if ($tool->state == 1 && (count($this->revisions) == 1 || count($this->revisions) > 1 && $this->revisions[1]->version == $tool->version)) {
$curtool = $tool;
break;
// No need to go further
}
}
return $curtool;
break;
case 'dev':
$devtool = null;
foreach ($this->revisions as $tool) {
// Current version
if ($tool->state == 3) {
$devtool = $tool;
break;
// No need to go further
}
}
return $devtool;
break;
default:
$rtool = null;
foreach ($this->revisions as $tool) {
if ($tool->revision == $idx) {
$rtool = $tool;
break;
// No need to go further
}
}
return $rtool;
break;
}
}
}
}
return $this->revisions;
}
/**
* Publish a tool
*
* @return void
*/
public function publishTask()
{
// Set the layout (note: all the views for this controller use the same layout)
$this->view->setLayout('display');
// Create a Tool object
$obj = new \Components\Tools\Tables\Tool($this->database);
// Do we have an alias?
if ($alias = Request::getVar('app', '')) {
$this->_toolid = $obj->getToolId($alias);
}
// Do we have a tool ID
if (!$this->_toolid) {
App::abort(403, Lang::txt('COM_TOOLS_ERROR_TOOL_NOT_FOUND'));
return;
}
// Get the tool status
$obj->getToolStatus($this->_toolid, $this->_option, $status, 'dev');
// Check for a status
if (count($status) <= 0) {
App::abort(500, Lang::txt('COM_TOOLS_ERR_CANNOT_RETRIEVE'));
return;
}
$result = true;
Log::debug("publish(): checkpoint 1:{$result}");
// get config
// Create a Tool Version object
$objV = new \Components\Tools\Tables\Version($this->database);
$objV->getToolVersions($this->_toolid, $tools, '', 1);
// make checks
if (!is_numeric($status['revision'])) {
// bad format
$result = false;
$this->setError(Lang::txt('COM_TOOLS_ERR_MISSING_REVISION_OR_BAD_FORMAT'));
} else {
if (count($tools) > 0 && $status['revision']) {
// check for duplicate revision
foreach ($tools as $t) {
if ($t->revision == $status['revision']) {
$result = false;
$this->setError(Lang::txt('COM_TOOLS_ERR_REVISION_EXISTS') . ' ' . $status['revision']);
}
}
// check that revision number is greater than in previous version
$currentrev = $objV->getCurrentVersionProperty($status['toolname'], 'revision');
if ($currentrev && intval($currentrev) > intval($status['revision'])) {
$result = false;
$this->setError(Lang::txt('COM_TOOLS_ERR_REVISION_GREATER'));
}
}
}
// Log checkpoint
Log::debug("publish(): checkpoint 2:{$result}, check revision");
// check if version is valid
if (!\Components\Tools\Models\Tool::validateVersion($status['version'], $error_v, $this->_toolid)) {
$result = false;
$this->setError($error_v);
}
// Log checkpoint
Log::debug("publish(): checkpoint 3:{$result}, running finalize tool");
// Run finalizetool
if (!$this->getError()) {
if ($this->_finalizeTool($out)) {
$this->setMessage(Lang::txt('COM_TOOLS_Version finalized.'));
} else {
$this->setError($out);
$result = false;
}
}
Log::debug("publish(): checkpoint 4:{$result}, running doi stuff");
// Register DOI handle
if ($result && $this->config->get('new_doi', 0)) {
include_once PATH_CORE . DS . 'components' . DS . 'com_resources' . DS . 'tables' . DS . 'doi.php';
// Collect metadata
$url = Request::base() . ltrim(Route::url('index.php?option=com_resources&id=' . $status['resourceid'] . '&rev=' . $status['revision']), DS);
// Check if DOI exists for this revision
$objDOI = new \Components\Resources\Tables\Doi($this->database);
$bingo = $objDOI->getDoi($status['resourceid'], $status['revision'], '', 1);
// DOI already exists for this revision
if ($bingo) {
$this->setError(Lang::txt('COM_TOOLS_ERR_DOI_ALREADY_EXISTS') . ': ' . $bingo);
} else {
// Get latest DOI label
$latestdoi = $objDOI->getLatestDoi($status['resourceid']);
$newlabel = $latestdoi ? intval($latestdoi) + 1 : 1;
// Collect metadata
$metadata = array('targetURL' => $url, 'title' => htmlspecialchars(stripslashes($status['title'])), 'version' => $status['version'], 'abstract' => htmlspecialchars(stripslashes($status['description'])));
// Get authors
$objA = new \Components\Tools\Tables\Author($this->database);
$authors = $objA->getAuthorsDOI($status['resourceid']);
// Register DOI
$doiSuccess = $objDOI->registerDOI($authors, $this->config, $metadata, $doierr);
// Save [new] DOI record
if ($doiSuccess) {
if (!$objDOI->loadDOI($status['resourceid'], $status['revision'])) {
if ($objDOI->saveDOI($status['revision'], $newlabel, $status['resourceid'], $status['toolname'], 0, $doiSuccess)) {
$this->setMessage(Lang::txt('COM_TOOLS_SUCCESS_DOI_CREATED') . ' ' . $doiSuccess);
} else {
$this->setError(Lang::txt('COM_TOOLS_ERR_DOI_STORE_FAILED'));
$result = false;
}
} else {
$this->setError(Lang::txt('COM_TOOLS_DOI already exists: ') . $objDOI->doi);
}
} else {
$this->setError(Lang::txt('COM_TOOLS_ERR_DOI_STORE_FAILED'));
$this->setError($doierr);
$result = false;
}
}
}
if ($result) {
$invokedir = rtrim($this->config->get('invokescript_dir', DS . 'apps'), "\\/");
$hzt = \Components\Tools\Models\Tool::getInstance($this->_toolid);
$hztv_cur = $hzt->getCurrentVersion();
$hztv_dev = $hzt->getDevelopmentVersion();
Log::debug("publish(): checkpoint 6:{$result}, running database stuff");
// create tool instance in the database
$newtool = $status['toolname'] . '_r' . $status['revision'];
// get version id
$currentid = is_object($hztv_cur) ? $hztv_cur->id : null;
$new = $currentid ? 0 : 1;
$devid = $hztv_dev->id;
$exportmap = array('@OPEN' => null, '@GROUP' => null, '@US' => 'us', '@PU' => 'pu', '@D1' => 'd1');
$new_hztv = \Components\Tools\Models\Version::createInstance($status['toolname'], $newtool);
$new_hztv->toolname = $status['toolname'];
$new_hztv->instance = $newtool;
$new_hztv->toolid = $this->_toolid;
$new_hztv->state = 1;
$new_hztv->title = $status['title'];
$new_hztv->version = $status['version'];
$new_hztv->revision = $status['revision'];
$new_hztv->description = $status['description'];
$new_hztv->toolaccess = $status['exec'];
$new_hztv->codeaccess = $status['code'];
$new_hztv->wikiaccess = $status['wiki'];
$new_hztv->vnc_geometry = $status['vncGeometry'];
$new_hztv->vnc_command = $invokedir . DS . $status['toolname'] . DS . 'r' . $status['revision'] . DS . 'middleware' . DS . 'invoke -T r' . $status['revision'];
$new_hztv->mw = $status['mw'];
$new_hztv->released = Date::toSql();
$new_hztv->released_by = User::get('username');
$new_hztv->license = $status['license'];
$new_hztv->fulltxt = $status['fulltxt'];
$new_hztv->exportControl = $exportmap[strtoupper($status['exec'])];
$new_hztv->owner = $hztv_dev->owner;
$new_hztv->member = $hztv_dev->member;
$new_hztv->vnc_timeout = $hztv_dev->vnc_timeout;
$new_hztv->hostreq = $hztv_dev->hostreq;
$new_hztv->params = $status['params'];
if (!$new_hztv->update()) {
$this->setError(Lang::txt('COM_TOOLS_ERROR_UPDATING_INSTANCE'));
$result = false;
} else {
$this->_setTracAccess($new_hztv->toolname, $new_hztv->codeaccess, $new_hztv->wikiaccess);
// update tool entry
$hzt = \Components\Tools\Models\Tool::getInstance($this->_toolid);
$hzt->add('version', $new_hztv->instance);
$hzt->update();
if ($hzt->published != 1) {
$hzt->published = 1;
// save tool info
if (!$hzt->update()) {
$this->setError(Lang::txt('COM_TOOLS_ERROR_UPDATING_INSTANCE'));
} else {
$this->setMessage(Lang::txt('COM_TOOLS_NOTICE_TOOL_MARKED_PUBLISHED'));
}
}
// unpublish previous version
if (!$new) {
if ($hzt->unpublishVersion($hztv_cur->instance)) {
$this->setMessage(Lang::txt('COM_TOOLS_NOTICE_UNPUBLISHED_PREV_VERSION_DB'));
} else {
$this->setError(Lang::txt('COM_TOOLS_ERR_FAILED_TO_UNPUBLISH_PREV_VERSION_DB'));
}
}
// get version id
$currentid = $new_hztv->id;
// save authors for this version
$objA = new \Components\Tools\Tables\Author($this->database);
if ($objA->saveAuthors($status['developers'], $currentid, $status['resourceid'], $status['revision'], $status['toolname'])) {
$this->setMessage(Lang::txt('COM_TOOLS_AUTHORS_SAVED'));
} else {
$this->setError(Lang::txt('COM_TOOLS_ERROR_SAVING_AUTHORS', $currentid));
}
// transfer screenshots
if ($devid && $currentid) {
include_once __DIR__ . DS . 'screenshots.php';
$screenshots = new Screenshots();
if ($screenshots->transfer($devid, $currentid, $status['resourceid'])) {
$this->setMessage(Lang::txt('COM_TOOLS_SCREENSHOTS_TRANSFERRED'));
} else {
$this->setError(Lang::txt('COM_TOOLS_ERROR_TRANSFERRING_SCREENSHOTS'));
}
}
include_once __DIR__ . DS . 'resource.php';
$resource = new Resource();
// update and publish resource page
$resource->updatePage($status['resourceid'], $status, '1', $new);
}
}
Log::debug("publish(): checkpoint 7:{$result}, gather output");
// Set errors to view
foreach ($this->getErrors() as $error) {
$this->view->setError($error);
}
// Set messages to view
$this->view->messages = $this->getMessages();
// Output HTML
if (!($no_html = Request::getInt('no_html', 0))) {
App::redirect(Route::url('index.php?option=' . $this->_option . '&controller=pipeline&task=status&app=' . $alias));
return;
}
$this->view->display();
}
