File Source for module_ctrl_xml

<?php
// $Id$
/**
* Contains class Module_CTRL_XML_Importer
*
* @package tangra_lib
* @subpackage modules_manager
*/
/**
*
*/
require_once(TANGRA_MAIN_DIR.'modules_manager/tangra_module_dbc.class.php');
/**
*
*/
require_once(TANGRA_MAIN_DIR.'modules_manager/tangra_module_release_dbc.class.php');
/**
*
*/
require_once(TANGRA_MAIN_DIR.'modules_manager/tangra_module_release_param_dbc.class.php');
/**
*
*/
require_once(TANGRA_MAIN_DIR.'modules_manager/tangra_module_release_relation_dbc.class.php');
/**
*
*/
require_once(TANGRA_MAIN_DIR.'modules_manager/tangra_module_category_dbc.class.php');
/**
*
*/
require_once(TANGRA_MAIN_DIR.'modules_manager/tangra_module_release_category_dbc.class.php');
/**
*
*/
require_once(TANGRA_MAIN_DIR.'modules_manager/tangra_module_license_dbc.class.php');
/**
* Module_CTRL_XML_Importer is used to import module.ctrl.xml files
*
* @package tangra_lib
* @subpackage modules_manager
*/
class Module_CTRL_XML_Importer extends Tangra_Class {
/**
* Location type "local"
*
*/
const LOCATION_TYPE_LOCAL = 0;
/**
* Location type "online repository"
*
*/
const LOCATION_TYPE_ONLINE = 1;
/**
* Imports module information parsed from $xml_str which have to contain valid XML
*
* @param DB_Connection $dbc
* @param string $xml_str
* @return array
*/
public static function import(DB_Connection $dbc, $xml_str) {
$ret = array('status' => 'error', 'module_release_hid' => '', 'module_release_id' => 0);
$xml = @simplexml_load_string($xml_str);
if ($xml !== false) {
$hid = trim($xml->name);
if ($hid) {
$module = new Tangra_Module_DBC();
$hid = addslashes($hid);
if (!$module->load_by_hid($dbc, $hid)) {
$module = Module_CTRL_XML_Importer::create_module($dbc, $xml);
$module_release = Module_CTRL_XML_Importer::create_module_release($dbc, $xml, $module->get_id());
$ret['status'] = 'imported';
$ret['module_hid'] = $module->get_hid();
$ret['module_release_id'] = $module_release->get_id();
$ret['module_release_hid'] = $module->get_hid().'-'.$module_release->get_version();
} else {
$last_available_release = Tangra_Module_Release_DBC::load_highest_online_release($dbc, $module->get_id());
$current_release_version = trim($xml->version);
if ($last_available_release) {
$module_release = new Tangra_Module_Release_DBC();
if ($module_release->load_by_module_and_version($dbc, $module->get_id(), $current_release_version)) {
Module_CTRL_XML_Importer::update_module_release($dbc, $xml, $module_release);
$ret['status'] = 'updated';
} else {
$module_release = Module_CTRL_XML_Importer::create_module_release($dbc, $xml, $module->get_id());
$ret['status'] = 'imported';
}
$ret['module_release_hid'] = $module->get_hid().'-'.$module_release->get_version();
$ret['module_release_id'] = $module_release->get_id();
} else {
// no releases are found so we are importing
if (Module_CTRL_XML_Importer::update_module($dbc, $xml, $module)) {
$module_release = Module_CTRL_XML_Importer::create_module_release($dbc, $xml, $module->get_id());
$ret['module_release_id'] = $module_release->get_id();
$ret['status'] = 'updated';
$ret['module_hid'] = $module->get_hid();
$ret['module_release_hid'] = $module->get_hid().'-'.$module_release->get_version();
} else {
$ret['status'] = 'error';
}
}
}
}
}
return $ret;
}
/**
* Captures basic module details as hid, description, maintainer, url and license
*
* @param DB_Connection $dbc
* @param SimpleXMLElement $xml SimpleXMLElement instance usualy returned by simplexml_load_string
* @return array
*/
public static function capture_module_details(DB_Connection $dbc, $xml) {
$ret = array('module' => array(), 'rez' => false, 'errors' => array());
$hid = trim($xml->name);
if ($hid) {
$description = trim($xml->description);
if ($description) {
$maintainer = trim($xml->maintainer);
if ($maintainer) {
$url = trim($xml->url);
$license_hid = trim($xml->licensehid);
$license = new Tangra_Module_License_DBC();
if ($license->load_by_hid($dbc, $license_hid)) {
$ret['rez'] = true;
$ret['module']['hid'] = $hid;
$ret['module']['description'] = $description;
$ret['module']['maintainer'] = $maintainer;
$ret['module']['url'] = $url;
$ret['module']['license'] = $license->get_id();
} else {
$ret['errors'][] = 'Cannot find license with HID = '.$license_hid;
}
} else {
$ret['errors'][] = 'Cannot find maintainer';
}
} else {
$ret['errors'][] = 'Cannot find description';
}
} else {
$ret['errors'][] = 'Cannot find module by HID';
}
return $ret;
}
/**
* Populates Tangra_Module_DBC object and saves it in DB
*
* @param DB_Connection $dbc
* @param SimpleXMLElement $xml
* @return Tangra_Module_DBC On success returns Tangra_Module_DBC, on failure false
* @internal
*/
private static function create_module(DB_Connection $dbc, $xml) {
$ret = false;
$mod_details = Module_CTRL_XML_Importer::capture_module_details($dbc, $xml);
if ($mod_details['rez']) {
$module = new Tangra_Module_DBC();
$module->set_hid($mod_details['module']['hid']);
$module->set_description($mod_details['module']['description']);
$module->set_maintainer($mod_details['module']['maintainer']);
$module->set_url($mod_details['module']['url']);
$module->set_license($mod_details['module']['license']);
$module->save($dbc);
$ret = $module;
}
return $ret;
}
/**
* Extracts module release details from SimpleXMLElement object
*
* @param SimpleXMLElement $xml
* @return array
*/
public static function capture_module_release_details($xml) {
$ret = array('mod_release' => array(),
'params' => array(),
'relations' => array(),
'category_hids' => array(),
'rez' => false,
'errors' => array());
$hid = trim($xml->name);
if ($hid) {
$version = trim($xml->version);
if ($version) {
$description = trim($xml->description);
if ($description) {
$maintainer = trim($xml->maintainer);
if ($maintainer) {
$url = trim($xml->url);
$requiresphpversion = trim($xml->requiresphpversion);
if ($requiresphpversion) {
$requirestangralib = trim($xml->requirestangralib);
if ($requirestangralib) {
$params = Module_CTRL_XML_Importer::captute_params($xml);
$relations = Module_CTRL_XML_Importer::capture_relations($xml);
$ret['rez'] = true;
$ret['mod_release']['hid'] = $hid;
$ret['mod_release']['version'] = $version;
$ret['mod_release']['description'] = $description;
$ret['mod_release']['maintainer'] = $maintainer;
$ret['mod_release']['url'] = $url;
$ret['mod_release']['requiresphpversion'] = $requiresphpversion;
$ret['mod_release']['requirestangralib'] = $requirestangralib;
$ret['params'] = $params;
$ret['relations'] = $relations;
foreach($xml->categoryhid as $chid) {
$ret['category_hids'][] = trim($chid);
}
} else {
$ret['errors'][] = 'Cannot find requirestangralib';
}
} else {
$ret['errors'][] = 'Cannot find requiresphpversion';
}
} else {
$ret['errors'][] = 'Cannot find maintainer';
}
} else {
$ret['errors'][] = 'Cannot find description';
}
} else {
$ret['errors'][] = 'Cannot find version';
}
} else {
$ret['errors'][] = 'Cannot find hid';
}
return $ret;
}
/**
* Extracts parameters from SimpleXMLElement object
*
* @param SimpleXMLElement $xml
* @return array
*/
public static function captute_params($xml) {
$ret = array('req' => array(), 'hard' => array(), 'soft' => array());
$params_req = array();
if ($xml->param_required) {
foreach($xml->param_required as $param) {
$ret['req'][] = trim($param);
}
}
$params_hard = array();
if ($xml->param_optional_hard) {
foreach($xml->param_optional_hard as $param) {
$ret['hard'][] = trim($param);
}
}
$params_soft = array();
if ($xml->param_optional_soft) {
foreach($xml->param_optional_soft as $param) {
$ret['soft'][] = trim($param);
}
}
return $ret;
}
/**
* Extracts relations from SimpleXMLElement object
*
* @param SimpleXMLElement $xml
* @return array
*/
public static function capture_relations($xml) {
$ret = array('depends' => array(),
'recommends' => array(),
'suggests' => array(),
'enhances' => array(),
'predepends' => array(),
'conflicts' => array(),
'provides' => array());
if ($xml->depends) {
foreach($xml->depends as $dep) {
$ret['depends'][trim($dep->module)] = trim($dep->versionrequirement);
}
}
if ($xml->provides) {
foreach($xml->provides as $prov) {
// TODO - this bellow is nonsense. Tag for "provides" must be "version", not "versionrequirement" (if any at all)
// The problem is that too many modules contain "provides" tag and shall be chanded and released
// May be here we need compatability fix which can parse both "version" and "versionrequirement"?
$ret['provides'][trim($prov->module)] = trim($prov->versionrequirement);
}
}
if ($xml->conflicts) {
foreach($xml->conflicts as $confl) {
$ret['conflicts'][trim($confl->module)] = trim($confl->versionrequirement);
}
}
if ($xml->recommends) {
foreach($xml->recommends as $rec) {
$ret['recommends'][trim($rec->module)] = trim($rec->versionrequirement);
}
}
if ($xml->suggests) {
foreach($xml->suggests as $sug) {
$ret['suggests'][trim($sug->module)] = trim($sug->versionrequirement);
}
}
if ($xml->enhances) {
foreach($xml->enhances as $enh) {
$ret['enhances'][trim($enh->module)] = trim($enh->versionrequirement);
}
}
if ($xml->predepends) {
foreach($xml->predepends as $pred) {
$ret['predepends'][trim($pred->module)] = trim($pred->versionrequirement);
}
}
return $ret;
}
/**
* Creates instance of Tangra_Module_Release_DBC, populates it and saves in DB
*
* @param DB_Connection $dbc
* @param SimpleXMLElement $xml
* @param integer $module_id
* @return Tangra_Module_Release_DBC on success returns Tangra_Module_Release_DBC object, on failure - false
* @internal
*/
private static function create_module_release(DB_Connection $dbc, $xml, $module_id) {
$ret = false;
$mod_release_details = Module_CTRL_XML_Importer::capture_module_release_details($xml);
if ($mod_release_details['rez']) {
$mod_release = new Tangra_Module_Release_DBC();
$mod_release->set_module($module_id);
$mod_release->set_version($mod_release_details['mod_release']['version']);
$mod_release->set_description($mod_release_details['mod_release']['description']);
$mod_release->set_maintainer($mod_release_details['mod_release']['maintainer']);
$mod_release->set_url($mod_release_details['mod_release']['url']);
$mod_release->set_requires_tangra_lib_version($mod_release_details['mod_release']['requiresphpversion']);
$mod_release->set_requires_php_version($mod_release_details['mod_release']['requirestangralib']);
$mod_release->set_online(true);
$mod_release->save($dbc);
Module_CTRL_XML_Importer::create_release_params_and_relations($dbc, $mod_release_details, $mod_release->get_id());
Module_CTRL_XML_Importer::create_links_to_categories($dbc, $mod_release_details, $mod_release->get_id());
$ret = $mod_release;
return $ret;
}
return $ret;
}
/**
* Creates release parameters and relations (Tangra_Module_Release_Param_DBC and Tangra_Module_Release_Relation_DBC)
*
* @param DB_Connection $dbc
* @param array $mod_release_details Array returned by Module_CTRL_XML_Importer::capture_module_release_details()
* @param integer $mod_release_id ID of module release
* @internal
*/
private static function create_release_params_and_relations(DB_Connection $dbc, $mod_release_details, $mod_release_id) {
foreach($mod_release_details['params']['req'] as $param_name) {
$param = new Tangra_Module_Release_Param_DBC();
$param->set_name($param_name);
$param->set_module_release($mod_release_id);
$param->set_type(Tangra_Module_Release_Param::TYPE_REQUIRED);
$param->save($dbc);
}
foreach($mod_release_details['params']['hard'] as $param_name) {
$param = new Tangra_Module_Release_Param_DBC();
$param->set_name($param_name);
$param->set_module_release($mod_release_id);
$param->set_type(Tangra_Module_Release_Param::TYPE_HARD_OPTIONAL);
$param->save($dbc);
}
foreach($mod_release_details['params']['soft'] as $param_name) {
$param = new Tangra_Module_Release_Param_DBC();
$param->set_name($param_name);
$param->set_module_release($mod_release_id);
$param->set_type(Tangra_Module_Release_Param::TYPE_SOFT_OPTIONAL);
$param->save($dbc);
}
foreach($mod_release_details['relations']['depends'] as $module_hid => $version_req) {
$rel = new Tangra_Module_Release_Relation_DBC();
$rel->set_module_release($mod_release_id);
$rel->set_relation_to($module_hid);
$rel->set_version_requirement($version_req);
$rel->set_type(Tangra_Module_Release_Relation_DBC::TYPE_DEPENDS);
$rel->save($dbc);
}
foreach($mod_release_details['relations']['provides'] as $module_hid => $version_req) {
$rel = new Tangra_Module_Release_Relation_DBC();
$rel->set_module_release($mod_release_id);
$rel->set_relation_to($module_hid);
$rel->set_version_requirement($version_req);
$rel->set_type(Tangra_Module_Release_Relation_DBC::TYPE_PROVIDES);
$rel->save($dbc);
}
foreach($mod_release_details['relations']['conflicts'] as $module_hid => $version_req) {
$rel = new Tangra_Module_Release_Relation_DBC();
$rel->set_module_release($mod_release_id);
$rel->set_relation_to($module_hid);
$rel->set_version_requirement($version_req);
$rel->set_type(Tangra_Module_Release_Relation_DBC::TYPE_CONFLICTS);
$rel->save($dbc);
}
foreach($mod_release_details['relations']['recommends'] as $module_hid => $version_req) {
$rel = new Tangra_Module_Release_Relation_DBC();
$rel->set_module_release($mod_release_id);
$rel->set_relation_to($module_hid);
$rel->set_version_requirement($version_req);
$rel->set_type(Tangra_Module_Release_Relation_DBC::TYPE_RECOMMENDS);
$rel->save($dbc);
}
foreach($mod_release_details['relations']['suggests'] as $module_hid => $version_req) {
$rel = new Tangra_Module_Release_Relation_DBC();
$rel->set_module_release($mod_release_id);
$rel->set_relation_to($module_hid);
$rel->set_version_requirement($version_req);
$rel->set_type(Tangra_Module_Release_Relation_DBC::TYPE_SUGGESTS);
$rel->save($dbc);
}
foreach($mod_release_details['relations']['enhances'] as $module_hid => $version_req) {
$rel = new Tangra_Module_Release_Relation_DBC();
$rel->set_module_release($mod_release_id);
$rel->set_relation_to($module_hid);
$rel->set_version_requirement($version_req);
$rel->set_type(TANGRA_MODULE_RELEASE_RELATION_DBC::TYPE_ENHANCES);
$rel->save($dbc);
}
foreach($mod_release_details['relations']['predepends'] as $module_hid => $version_req) {
$rel = new Tangra_Module_Release_Relation_DBC();
$rel->set_module_release($mod_release_id);
$rel->set_relation_to($module_hid);
$rel->set_version_requirement($version_req);
$rel->set_type(Tangra_Module_Release_Relation_DBC::TYPE_PREDEPENDS);
$rel->save($dbc);
}
}
/**
* Creates links (Tangra_Module_Release_Category_DBC) to module categories
*
* @param DB_Connection $dbc
* @param array $mod_release_details Array returned by Module_CTRL_XML_Importer::capture_module_release_details()
* @param integer $mod_release_id ID of module release
* @internal
*/
private static function create_links_to_categories(DB_Connection $dbc, $mod_release_details, $mod_release_id) {
foreach($mod_release_details['category_hids'] as $chid) {
$category = new Tangra_Module_Category_DBC();
if ($category->load_by_hid($dbc, $chid)) {
$cat_link = new Tangra_Module_Release_Category_DBC();
$cat_link->set_category($category->get_id());
$cat_link->set_module_release($mod_release_id);
$cat_link->save($dbc);
}
}
}
/**
* Updates Module_CTRL_XML_Importer object and saves it in DB
*
* @param DB_Connection $dbc
* @param SimpleXMLElement $xml
* @param Tangra_Module_DBC $module
* @return Tangra_Module_DBC On success returns Tangra_Module_DBC object, on failure - false
* @internal
*/
private static function update_module(DB_Connection $dbc, $xml, Tangra_Module_DBC $module) {
$ret = false;
$mod_details = Module_CTRL_XML_Importer::capture_module_details($dbc, $xml);
if ($mod_details['rez']) {
$module->set_description($mod_details['module']['description']);
$module->set_maintainer($mod_details['module']['maintainer']);
$module->set_url($mod_details['module']['url']);
$module->set_license($mod_details['module']['license']);
$module->save($dbc);
$ret = $module;
}
return $ret;
}
/**
* Updates Tangra_Module_Release_DBC object and saves it in DB
*
* @param DB_Connection $dbc
* @param SimpleXMLElement $xml
* @param Tangra_Module_Release_DBC $mod_release
* @return boolean On success returns true, on failure - false
* @internal
*/
private static function update_module_release(DB_Connection $dbc, $xml, Tangra_Module_Release_DBC $mod_release) {
$ret = false;
$mod_release_details = Module_CTRL_XML_Importer::capture_module_release_details($xml);
if ($mod_release_details) {
$mod_release->set_version($mod_release_details['mod_release']['version']);
$mod_release->set_description($mod_release_details['mod_release']['description']);
$mod_release->set_maintainer($mod_release_details['mod_release']['maintainer']);
$mod_release->set_url($mod_release_details['mod_release']['url']);
$mod_release->set_requires_tangra_lib_version($mod_release_details['mod_release']['requiresphpversion']);
$mod_release->set_requires_php_version($mod_release_details['mod_release']['requirestangralib']);
$mod_release->set_online(true);
$mod_release->save($dbc);
Tangra_Module_Release_Param_DBC::delete_for_release($dbc, $mod_release->get_id());
Tangra_Module_Release_Relation_DBC::delete_for_release($dbc, $mod_release->get_id());
Module_CTRL_XML_Importer::create_release_params_and_relations($dbc, $mod_release_details, $mod_release->get_id());
Tangra_Module_Release_Category_DBC::delete_for_release($dbc, $mod_release->get_id());
Module_CTRL_XML_Importer::create_links_to_categories($dbc, $mod_release_details, $mod_release->get_id());
$ret = true;
}
return $ret;
}
}

Source for file module_ctrl_xml_importer.class.php