vtenext/vtlib/Vtiger/PackageUpdate.php
2021-04-28 20:10:26 +02:00

566 lines
19 KiB
PHP

<?php
/* crmv@198038 */
/*************************************
* SPDX-FileCopyrightText: 2009-2020 Vtenext S.r.l. <info@vtenext.com>
* SPDX-License-Identifier: AGPL-3.0-only
************************************/
include_once('vtlib/Vtiger/PackageImport.php');
/* crmv@104975 crmv@146434 */
/**
* Provides API to update module into vtiger CRM
* @package vtlib
*/
class Vtiger_PackageUpdate extends Vtiger_PackageImport {
var $_migrationinfo = false;
/**
* Constructor
*/
function __construct() {
parent::__construct();
}
/**
* Initialize Update
* @access private
*/
function initUpdate($moduleInstance, $zipfile, $overwrite) {
$module = $this->getModuleNameFromZip($zipfile);
if(!$moduleInstance || $moduleInstance->name != $module) {
self::log('Module name mismatch!');
return false;
}
if($module != null) {
$unzip = new Vtiger_Unzip($zipfile, $overwrite);
// Unzip selectively
$unzip->unzipAllEx( ".",
Array(
//crmv@sdk
'include' => Array('templates', "modules/$module", 'sdk'), // We don't need manifest.xml
//crmv@sdk e
//'exclude' => Array('manifest.xml') // DEFAULT: excludes all not in include
),
Array(
// Templates folder to be renamed while copying
'templates' => "Smarty/templates/modules/$module",
'sdk' => 'modules/SDK/tmp', //crmv@sdk
// Cron folder to be renamed while copying
'cron' => "cron/modules/$module",
)
);
// If data is not yet available
if(empty($this->_modulexml)) {
$this->__parseManifestFile($unzip);
}
if($unzip) $unzip->close();
}
return $module;
}
/**
* Update Module from zip file
* @param Vtiger_Module Instance of the module to update
* @param String Zip file name
* @param Boolean True for overwriting existing module
*/
function update($moduleInstance, $zipfile, $overwrite=true) {
$module = $this->initUpdate($moduleInstance, $zipfile, $overwrite);
if($module) {
// Call module update function
$this->update_Module($moduleInstance);
}
unlink($zipfile); // crmv@181170
}
/**
* Update Module
* @access private
*/
function update_Module($moduleInstance, $options=array()) {
$update_steps = array(
'fire_event_preupdate'=>true,
'migration'=>true,
'panels'=>true,
'blocks'=>true,
'customviews'=>true,
'sharing_access'=>true,
'events'=>true,
'actions'=>true,
'relatedlists'=>true,
'modlights'=>true,
'sdk'=>true,
'fire_event_postupdate'=>true,
);
if (!empty($options)) $update_steps = array_merge($update_steps, $options);
$tabname = $this->_modulexml->name;
$tablabel= $this->_modulexml->label;
$parenttab=$this->_modulexml->parent;
$tabversion=$this->_modulexml->version;
$isextension= false;
if(!empty($this->_modulexml->type)) {
$type = strtolower($this->_modulexml->type);
if($type == 'extension' || $type == 'language')
$isextension = true;
}
if ($update_steps['fire_event_preupdate']) {
Vtiger_Module::fireEvent($moduleInstance->name, Vtiger_Module::EVENT_MODULE_PREUPDATE);
}
// TODO Handle module property changes like menu, label etc...
/*if(!empty($parenttab) && $parenttab != '') {
$menuInstance = Vtiger_Menu::getInstance($parenttab);
$menuInstance->addModule($moduleInstance);
}*/
if ($update_steps['migration']) {
$this->handle_Migration($this->_modulexml, $moduleInstance);
}
$this->update_Tables($this->_modulexml); //crmv@157615
if ($update_steps['panels']) {
$this->update_Panels($this->_modulexml, $moduleInstance);
}
if ($update_steps['blocks']) {
$this->update_Orphaned_Blocks($this->_modulexml, $moduleInstance);
}
if ($update_steps['customviews']) {
$this->update_CustomViews($this->_modulexml, $moduleInstance);
}
if ($update_steps['sharing_access']) {
$this->update_SharingAccess($this->_modulexml, $moduleInstance);
}
if ($update_steps['events']) {
$this->update_Events($this->_modulexml, $moduleInstance);
}
if ($update_steps['actions']) {
$this->update_Actions($this->_modulexml, $moduleInstance);
}
if ($update_steps['relatedlists']) {
$this->update_RelatedLists($this->_modulexml, $moduleInstance);
}
if ($update_steps['modlights']) {
$this->update_Modlights($this->_modulexml, $moduleInstance);
}
if ($update_steps['sdk']) {
SDK::importPackage($this->_modulexml, $moduleInstance); //crmv@sdk
}
$moduleInstance->__updateVersion($tabversion);
if ($update_steps['fire_event_postupdate']) {
Vtiger_Module::fireEvent($moduleInstance->name, Vtiger_Module::EVENT_MODULE_POSTUPDATE,$tabversion); //crmv@fix
}
}
/**
* Parse migration information from manifest
* @access private
*/
function parse_Migration($modulenode) {
if(!$this->_migrations) {
$this->_migrations = Array();
if(!empty($modulenode->migrations) &&
!empty($modulenode->migrations->migration)) {
foreach($modulenode->migrations->migration as $migrationnode) {
$migrationattrs = $migrationnode->attributes();
$migrationversion = $migrationattrs['version'];
$this->_migrations["$migrationversion"] = $migrationnode;
}
}
// Sort the migration details based on version
if(count($this->_migrations) > 1) {
uksort($this->_migrations, 'version_compare');
}
}
}
/**
* Handle migration of the module
* @access private
*/
function handle_Migration($modulenode, $moduleInstance) {
// TODO Handle module migration SQL
$this->parse_Migration($modulenode);
$cur_version = $moduleInstance->version;
foreach($this->_migrations as $migversion=>$migrationnode) {
// Perform migration only for higher version than current
if(version_compare($cur_version, $migversion, '<')) {
self::log("Migrating to $migversion ... STARTED");
if(!empty($migrationnode->tables) && !empty($migrationnode->tables->table)) {
foreach($migrationnode->tables->table as $tablenode) {
$tablename = $tablenode->name;
$tablesql = "$tablenode->sql"; // Convert to string
// Skip SQL which are destructive
if(Vtiger_Utils::IsDestructiveSql($tablesql)) {
self::log("SQL: $tablesql ... SKIPPED");
} else {
// Supress any SQL query failures
self::log("SQL: $tablesql ... ", false);
Vtiger_Utils::ExecuteQuery($tablesql, true);
self::log("DONE");
}
}
}
self::log("Migrating to $migversion ... DONE");
}
}
}
/**
* Update Tables of the module
* @access private
*/
//crmv@157615
function update_Tables($modulenode) {
global $adb, $table_prefix;
//$this->import_Tables($modulenode);
// update the table (add new columns)
foreach($modulenode->tables->table as $tablenode) {
$tablename = $tablenode->name;
//crmv@30456
if(strpos($tablename, 'TABLEPREFIX') !== false){
$tablename=str_replace('TABLEPREFIX', $table_prefix, $tablename);
}
//crmv@30456e
$tablesql = "$tablenode->sql"; // Convert to string format
//crmv@30456
if(strpos($tablesql, 'TABLEPREFIX') !== false){
$tablesql=str_replace('TABLEPREFIX', $table_prefix, $tablesql);
}
//crmv@30456e
// Add columns to existing tables
if(Vtiger_Utils::checkTable($tablename)) {
$schema_obj = new adoSchema( $adb->database );
$schema_elements = $schema_obj->ParseSchemaString(trim($tablesql));
if (!empty($schema_elements)) {
foreach($schema_elements as $schema_element) {
if (stripos($schema_element,'alter table ') !== false && stripos($schema_element,' add ') !== false) {
//crmv@172745 if index exists remove and add again
if (stripos($schema_element,' index ') !== false) {
$tmp = substr($schema_element, stripos($schema_element,' index '));
$tmp = explode(' ',$tmp);
$index_name = $tmp[2];
$indexes = $adb->database->MetaIndexes($tablename);
if (array_key_exists($index_name, $indexes)) {
$sql = $adb->datadict->DropIndexSQL($index_name,$tablename);
$adb->datadict->ExecuteSQLArray((Array)$sql);
}
}
//crmv@172745e
$adb->query($schema_element);
}
}
}
}
}
}
//crmv@157615e
/**
* Update Panels of the module
* @access private
*/
function update_Panels($modulenode, $moduleInstance) {
if(empty($modulenode->panels) || empty($modulenode->panels->panel)) return;
foreach($modulenode->panels->panel as $panelnode) {
$panelInstance = Vtiger_Panel::getInstance($panelnode->label, $moduleInstance);
if(!$panelInstance) {
$panelInstance = $this->import_Panel($modulenode, $moduleInstance, $panelnode);
} else {
$this->update_Panel($modulenode, $moduleInstance, $panelnode, $panelInstance);
}
$this->update_Blocks($panelnode, $panelInstance, $moduleInstance);
}
}
/**
* Update Panel of the module
* @access private
*/
function update_Panel($modulenode, $moduleInstance, $panelnode, $panelInstance) {
// TODO Handle panel property update
}
/**
* Update Blocks of the module
* @access private
*/
function update_Orphaned_Blocks($modulenode, $moduleInstance) {
if(empty($modulenode->blocks) || empty($modulenode->blocks->block)) return;
foreach($modulenode->blocks->block as $blocknode) {
$blockInstance = Vtiger_Block::getInstance($blocknode->label, $moduleInstance);
if(!$blockInstance) {
$panelInstance = Vtiger_Panel::getFirstForModule($moduleInstance);
if (!$panelInstance) {
$panelInstance = $this->create_Main_Panel();
}
$blockInstance = $this->import_Block(null, $panelInstance, $moduleInstance, $blocknode);
} else {
$this->update_Block(null, $blockInstance->panel, $modulenode, $moduleInstance, $blocknode, $blockInstance);
}
$this->update_Fields($blocknode, $blockInstance, $moduleInstance);
}
}
/**
* Update Blocks of the module
* @access private
*/
function update_Blocks($panelnode, $panelInstance, $moduleInstance) {
if(empty($panelnode->blocks) || empty($panelnode->blocks->block)) return;
foreach($panelnode->blocks->block as $blocknode) {
$blockInstance = Vtiger_Block::getInstance($blocknode->label, $moduleInstance);
if(!$blockInstance) {
$blockInstance = $this->import_Block($panelnode, $panelInstance, $moduleInstance, $blocknode);
} else {
$this->update_Block($panelnode, $panelInstance, $moduleInstance, $blocknode, $blockInstance);
}
$this->update_Fields($blocknode, $blockInstance, $moduleInstance);
}
}
/**
* Update Block of the module
* @access private
*/
function update_Block($panelnode, $panelInstance, $moduleInstance, $blocknode, $blockInstance) {
if (isset($blocknode->display_status)) $blockInstance->setDisplayStatus($blocknode->display_status);
if (isset($blocknode->sequence)) $blockInstance->setSequence($blocknode->sequence);
$blockInstance->setPanel($panelInstance->id);
}
/**
* Update Fields of the module
* @access private
*/
function update_Fields($blocknode, $blockInstance, $moduleInstance) {
if(empty($blocknode->fields) || empty($blocknode->fields->field)) return;
foreach($blocknode->fields->field as $fieldnode) {
$fieldInstance = Vtiger_Field::getInstance($fieldnode->fieldname, $moduleInstance);
if(!$fieldInstance) {
$fieldInstance = $this->import_Field($blocknode, $blockInstance, $moduleInstance, $fieldnode);
} else {
$fieldInstance->block = $blockInstance;
if (isset($fieldnode->fieldlabel)) $fieldInstance->label = strval($fieldnode->fieldlabel);
if (isset($fieldnode->helpinfo)) $fieldInstance->helpinfo= strval($fieldnode->helpinfo);
if (isset($fieldnode->masseditable)) $fieldInstance->masseditable = strval($fieldnode->masseditable);
if (isset($fieldnode->uitype)) $fieldInstance->uitype = strval($fieldnode->uitype);
if (isset($fieldnode->typeofdata)) $fieldInstance->typeofdata = strval($fieldnode->typeofdata);
if (isset($fieldnode->displaytype)) $fieldInstance->displaytype = strval($fieldnode->displaytype);
if (isset($fieldnode->generatedtype)) $fieldInstance->generatedtype = strval($fieldnode->generatedtype);
if (isset($fieldnode->readonly)) $fieldInstance->readonly = strval($fieldnode->readonly);
if (isset($fieldnode->presence)) $fieldInstance->presence= strval($fieldnode->presence);
if (isset($fieldnode->selected)) $fieldInstance->selected = strval($fieldnode->selected);
if (isset($fieldnode->maximumlength)) $fieldInstance->maximumlength = strval($fieldnode->maximumlength);
if (isset($fieldnode->sequence)) $fieldInstance->sequence = strval($fieldnode->sequence);
if (isset($fieldnode->quickcreate)) $fieldInstance->quickcreate = strval($fieldnode->quickcreate);
if (isset($fieldnode->quickcreatesequence)) $fieldInstance->quicksequence = strval($fieldnode->quickcreatesequence);
if (isset($fieldnode->info_type)) $fieldInstance->info_type = strval($fieldnode->info_type);
//crmv@163337 add new picklist values
if(!empty($fieldnode->picklistvalues) && isset($fieldnode->picklistvalues->picklistvalue)) {
$picklistvalues = Array();
$picklistvalues_real_values = Array();
foreach($fieldnode->picklistvalues->picklistvalue as $picklistvaluenode) {
$picklistvalues[] = to_html(strval($picklistvaluenode));
$picklistvalues_real_values[to_html(strval($picklistvaluenode))] = strval($picklistvaluenode);
}
$currentPicklistValues = vtlib_getPicklistValues($fieldnode->fieldname);
$newPicklistValues = array_diff($picklistvalues, $currentPicklistValues);
if (!empty($newPicklistValues)) {
foreach($newPicklistValues as &$newPicklistValue) {
$newPicklistValue = $picklistvalues_real_values[$newPicklistValue];
}
$fieldInstance->setPicklistValues($newPicklistValues);
}
}
//crmv@163337e
// TODO relatedmodules
$this->update_Field($blocknode, $blockInstance, $moduleInstance, $fieldnode, $fieldInstance);
$fieldinfo = array();
if(!empty($fieldnode->info)) {
foreach($fieldnode->info as $info) {
foreach($info as $k => $v) {
$fieldinfo[$k] = Zend_Json::decode(strval($v));
if ($fieldInstance->uitype == '50' && !empty($fieldinfo[$k])) {
foreach($fieldinfo[$k] as &$user) if ($user != '') $user = getUserId_Ol($user);
}
}
}
}
$fieldInstance->setFieldInfo($fieldinfo);
}
$this->__AddModuleFieldToCache($moduleInstance, $fieldInstance->name, $fieldInstance);
}
}
/**
* Update Field of the module
* @access private
*/
function update_Field($blocknode, $blockInstance, $moduleInstance, $fieldnode, $fieldInstance) {
$fieldInstance->save($blockInstance);
}
/**
* Import Custom views of the module
* @access private
*/
function update_CustomViews($modulenode, $moduleInstance) {
if(empty($modulenode->customviews) || empty($modulenode->customviews->customview)) return;
foreach($modulenode->customviews->customview as $customviewnode) {
$filterInstance = Vtiger_Filter::getInstance($customviewnode->viewname, $moduleInstance);
if(!$filterInstance) {
$filterInstance = $this->import_CustomView($modulenode, $moduleInstance, $customviewnode);
} else {
$this->update_CustomView($modulenode, $moduleInstance, $customviewnode, $filterInstance);
}
}
}
/**
* Update Custom View of the module
* @access private
*/
function update_CustomView($modulenode, $moduleInstance, $customviewnode, $filterInstance) {
// TODO Handle filter property update
}
/**
* Update Sharing Access of the module
* @access private
*/
function update_SharingAccess($modulenode, $moduleInstance) {
if(empty($modulenode->sharingaccess)) return;
// TODO Handle sharing access property update
}
/**
* Update Events of the module
* @access private
*/
function update_Events($modulenode, $moduleInstance) {
if(empty($modulenode->events) || empty($modulenode->events->event)) return;
if(Vtiger_Event::hasSupport()) {
foreach($modulenode->events->event as $eventnode) {
$this->update_Event($modulenode, $moduleInstance, $eventnode);
}
}
}
/**
* Update Event of the module
* @access private
*/
function update_Event($modulenode, $moduleInstance, $eventnode) {
//Vtiger_Event::register($moduleInstance, $eventnode->eventname, $eventnode->classname, $eventnode->filename);
// TODO Handle event property update
}
/**
* Update actions of the module
* @access private
*/
function update_Actions($modulenode, $moduleInstance) {
if(empty($modulenode->actions) || empty($modulenode->actions->action)) return;
foreach($modulenode->actions->action as $actionnode) {
$this->update_Action($modulenode, $moduleInstance, $actionnode);
}
}
/**
* Update action of the module
* @access private
*/
function update_Action($modulenode, $moduleInstance, $actionnode) {
// TODO Handle action property update
}
/**
* Update related lists of the module
* @access private
*/
function update_RelatedLists($modulenode, $moduleInstance) {
if(empty($modulenode->relatedlists) || empty($modulenode->relatedlists->relatedlist)) return;
//$moduleInstance->deleteRelatedLists(); //crmv@27882
foreach($modulenode->relatedlists->relatedlist as $relatedlistnode) {
$relModuleInstance = $this->update_Relatedlist($modulenode, $moduleInstance, $relatedlistnode);
}
}
/**
* Import related list of the module.
* @access private
*/
function update_Relatedlist($modulenode, $moduleInstance, $relatedlistnode) {
$relModuleInstance = Vtiger_Module::getInstance($relatedlistnode->relatedmodule);
$label = $relatedlistnode->label;
$actions = false;
if(!empty($relatedlistnode->actions) && !empty($relatedlistnode->actions->action)) {
$actions = Array();
foreach($relatedlistnode->actions->action as $actionnode) {
$actions[] = "$actionnode";
}
}
if($relModuleInstance) {
$moduleInstance->unsetRelatedList($relModuleInstance, "$label", "$relatedlistnode->function");
$relid = $moduleInstance->setRelatedList($relModuleInstance, "$label", $actions, "$relatedlistnode->function", "$relatedlistnode->sequence", "$relatedlistnode->presence");
}
if(!empty($relid) && !empty($relatedlistnode->panels)) {
foreach($relatedlistnode->panels as $panel) {
foreach($panel as $p) {
$panelInstance = Vtecrm_Panel::getInstance($p->label,$moduleInstance);
$panelInstance->addRelatedList($relid,$p->sequence);
}
}
}
return $relModuleInstance;
}
function update_Modlights($modulenode, $moduleInstance) {
if(empty($modulenode->modlights) || empty($modulenode->modlights->module)) return;
foreach($modulenode->modlights->module as $modlightnode) {
if (isModuleInstalled("$modlightnode->name")) {
$package = new Vtiger_Package();
$package->_modulexml = $modlightnode;
$package->update_Module(Vtecrm_Module::getInstance("$modlightnode->name"), array(
'fire_event_preupdate'=>false,
'migration'=>false,
'modlights'=>false,
'fire_event_postupdate'=>false,
));
} else {
$this->import_Modlight($modlightnode); // crmv@197127
}
}
}
}