2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
3 /*********************************************************************************
4 * SugarCRM Community Edition is a customer relationship management program developed by
5 * SugarCRM, Inc. Copyright (C) 2004-2012 SugarCRM Inc.
7 * This program is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU Affero General Public License version 3 as published by the
9 * Free Software Foundation with the addition of the following permission added
10 * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
11 * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
12 * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
14 * This program is distributed in the hope that it will be useful, but WITHOUT
15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16 * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
19 * You should have received a copy of the GNU Affero General Public License along with
20 * this program; if not, see http://www.gnu.org/licenses or write to the Free
21 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
24 * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
25 * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
27 * The interactive user interfaces in modified source and object code versions
28 * of this program must display Appropriate Legal Notices, as required under
29 * Section 5 of the GNU Affero General Public License version 3.
31 * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
32 * these Appropriate Legal Notices must retain the display of the "Powered by
33 * SugarCRM" logo. If the display of the logo is not reasonably feasible for
34 * technical reasons, the Appropriate Legal Notices must display the words
35 * "Powered by SugarCRM".
36 ********************************************************************************/
40 * ModuleInstaller - takes an installation package from files in the custom/Extension/X directories, and moves them into custom/X to install them.
41 * If a directory has multiple files they are concatenated together.
42 * Relevant directories (X) are Layoutdefs, Vardefs, Include (bean stuff), Language, TableDictionary (relationships)
44 * Installation steps that involve more than just copying files:
45 * 1. installing custom fields - calls bean->custom_fields->addField
46 * 2. installing relationships - calls createTableParams to build the relationship table, and createRelationshipMeta to add the relationship to the relationship table
47 * 3. rebuilding the relationships - at almost the last step in install(), calls modules/Administration/RebuildRelationship.php
48 * 4. repair indices - uses "modules/Administration/RepairIndex.php";
53 require_once('include/utils/progress_bar_utils.php');
55 require_once('ModuleInstall/ModuleScanner.php');
56 define('DISABLED_PATH', 'Disabled');
58 class ModuleInstaller{
59 var $modules = array();
62 var $modulesInPackage = array();
63 public $disabled_path = DISABLED_PATH;
65 function ModuleInstaller(){
66 $this->ms = new ModuleScanner();
67 $this->modules = get_module_dir_list();
68 $this->db = & DBManagerFactory::getInstance();
69 include("ModuleInstall/extensions.php");
70 $this->extensions = $extensions;
74 * ModuleInstaller->install includes the manifest.php from the base directory it has been given. If it has been asked to do an upgrade it checks to see if there is
75 * an upgrade_manifest defined in the manifest; if not it errors. It then adds the bean into the custom/Extension/application/Ext/Include/<module>.php - sets beanList, beanFiles
76 * and moduleList - and then calls ModuleInstaller->merge_files('Ext/Include', 'modules.ext.php', '', true) to merge the individual module files into a combined file
77 * /custom/Extension/application/Ext/Include/modules.ext.php (which now contains a list of all $beanList, $beanFiles and $moduleList for all extension modules) -
78 * this file modules.ext.php is included at the end of modules.php.
80 * Finally it runs over a list of defined tasks; then install_beans, then install_custom_fields, then clear the Vardefs, run a RepairAndClear, then finally call rebuild_relationships.
82 function install($base_dir, $is_upgrade = false, $previous_version = ''){
83 if(defined('TEMPLATE_URL'))SugarTemplateUtilities::disableCache();
84 if(!empty($GLOBALS['sugar_config']['moduleInstaller']['packageScan'])){
85 $this->ms->scanPackage($base_dir);
86 if($this->ms->hasIssues()){
87 $this->ms->displayIssues();
92 // workaround for bug 45812 - refresh vardefs cache before unpacking to avoid partial vardefs in cache
94 foreach ($this->modules as $module_name) {
95 if (!empty($beanList[$module_name])) {
96 $objectName = BeanFactory::getObjectName($module_name);
97 VardefManager::loadVardef($module_name, $objectName);
101 global $app_strings, $mod_strings;
102 $this->base_dir = $base_dir;
103 $total_steps = 5; //minimum number of steps with no tasks
108 'install_extensions',
112 'install_connectors',
113 'install_layoutfields',
114 'install_relationships',
115 'enable_manifest_logichooks',
120 $total_steps += count($tasks);
121 if(file_exists($this->base_dir . '/manifest.php')){
124 display_progress_bar('install', $current_step, $total_steps);
125 echo '<div id ="displayLoglink" ><a href="#" onclick="document.getElementById(\'displayLog\').style.display=\'\'">'
126 .$app_strings['LBL_DISPLAY_LOG'].'</a> </div><div id="displayLog" style="display:none">';
129 include($this->base_dir . '/manifest.php');
130 if($is_upgrade && !empty($previous_version)){
131 //check if the upgrade path exists
132 if(!empty($upgrade_manifest)){
133 if(!empty($upgrade_manifest['upgrade_paths'])){
134 if(!empty($upgrade_manifest['upgrade_paths'][$previous_version])){
135 $installdefs = $upgrade_manifest['upgrade_paths'][$previous_version];
137 $errors[] = 'No Upgrade Path Found in manifest.';
138 $this->abort($errors);
143 $this->id_name = $installdefs['id'];
144 $this->installdefs = $installdefs;
147 update_progress_bar('install', $current_step, $total_steps);
150 foreach($tasks as $task){
154 update_progress_bar('install', $current_step, $total_steps);
157 $this->install_beans($this->installed_modules);
160 update_progress_bar('install', $total_steps, $total_steps);
162 if(isset($installdefs['custom_fields'])){
163 $this->log(translate('LBL_MI_IN_CUSTOMFIELD'));
164 $this->install_custom_fields($installdefs['custom_fields']);
168 update_progress_bar('install', $current_step, $total_steps);
173 update_progress_bar('install', $current_step, $total_steps);
176 $selectedActions = array(
182 'rebuildAuditTables',
185 VardefManager::clearVardef();
186 global $beanList, $beanFiles, $moduleList;
187 if (file_exists('custom/application/Ext/Include/modules.ext.php'))
189 include('custom/application/Ext/Include/modules.ext.php');
191 require_once("modules/Administration/upgrade_custom_relationships.php");
192 upgrade_custom_relationships($this->installed_modules);
193 $this->rebuild_all(true);
194 require_once('modules/Administration/QuickRepairAndRebuild.php');
195 $rac = new RepairAndClear();
196 $rac->repairAndClearAll($selectedActions, $this->installed_modules,true, false);
197 $this->rebuild_relationships();
198 UpdateSystemTabs('Add',$this->tab_modules);
199 //Clear out all the langauge cache files.
200 clearAllJsAndJsLangFilesWithoutOutput();
201 $cache_key = 'app_list_strings.'.$GLOBALS['current_language'];
202 sugar_cache_clear($cache_key );
205 //clear the unified_search_module.php file
206 require_once('modules/Home/UnifiedSearchAdvanced.php');
207 UnifiedSearchAdvanced::unlinkUnifiedSearchModulesFile();
209 $this->log('<br><b>' . translate('LBL_MI_COMPLETE') . '</b>');
211 die("No \$installdefs Defined In $this->base_dir/manifest.php");
216 function install_user_prefs($module, $hide_from_user=false){
217 UserPreference::updateAllUserPrefs('display_tabs', $module, '', true, !$hide_from_user);
218 UserPreference::updateAllUserPrefs('hide_tabs', $module, '', true, $hide_from_user);
219 UserPreference::updateAllUserPrefs('remove_tabs', $module, '', true, $hide_from_user);
221 function uninstall_user_prefs($module){
222 UserPreference::updateAllUserPrefs('display_tabs', $module, '', true, true);
223 UserPreference::updateAllUserPrefs('hide_tabs', $module, '', true, true);
224 UserPreference::updateAllUserPrefs('remove_tabs', $module, '', true, true);
227 function pre_execute(){
228 require_once($this->base_dir . '/manifest.php');
229 if(isset($this->installdefs['pre_execute']) && is_array($this->installdefs['pre_execute'])){
230 foreach($this->installdefs['pre_execute'] as $includefile){
231 require_once(str_replace('<basepath>', $this->base_dir, $includefile));
236 function post_execute(){
237 require_once($this->base_dir . '/manifest.php');
238 if(isset($this->installdefs['post_execute']) && is_array($this->installdefs['post_execute'])){
239 foreach($this->installdefs['post_execute'] as $includefile){
240 require_once(str_replace('<basepath>', $this->base_dir, $includefile));
245 function pre_uninstall(){
246 require_once($this->base_dir . '/manifest.php');
247 if(isset($this->installdefs['pre_uninstall']) && is_array($this->installdefs['pre_uninstall'])){
248 foreach($this->installdefs['pre_uninstall'] as $includefile){
249 require_once(str_replace('<basepath>', $this->base_dir, $includefile));
254 function post_uninstall(){
255 require_once($this->base_dir . '/manifest.php');
256 if(isset($this->installdefs['post_uninstall']) && is_array($this->installdefs['post_uninstall'])){
257 foreach($this->installdefs['post_uninstall'] as $includefile){
258 require_once(str_replace('<basepath>', $this->base_dir, $includefile));
264 * ModuleInstaller->install_copy gets the copy section of installdefs in the manifest and calls copy_path to copy each path (file or directory) to its final location
265 * (specified as from and to in the manifest), replacing <basepath> by the base_dir value passed in to install.
267 function install_copy(){
268 if(isset($this->installdefs['copy'])){
269 /* BEGIN - RESTORE POINT - by MR. MILK August 31, 2005 02:22:11 PM */
270 $backup_path = clean_path( remove_file_extension(urldecode(hashToFile($_REQUEST['install_file'])))."-restore" );
271 /* END - RESTORE POINT - by MR. MILK August 31, 2005 02:22:18 PM */
272 foreach($this->installdefs['copy'] as $cp){
273 $GLOBALS['log']->debug("Copying ..." . $cp['from']. " to " .$cp['to'] );
274 /* BEGIN - RESTORE POINT - by MR. MILK August 31, 2005 02:22:11 PM */
275 //$this->copy_path($cp['from'], $cp['to']);
276 $this->copy_path($cp['from'], $cp['to'], $backup_path);
277 /* END - RESTORE POINT - by MR. MILK August 31, 2005 02:22:18 PM */
279 //here we should get the module list again as we could have copied something to the modules dir
280 $this->modules = get_module_dir_list();
283 function uninstall_copy(){
284 if(!empty($this->installdefs['copy'])){
285 foreach($this->installdefs['copy'] as $cp){
286 $cp['to'] = clean_path(str_replace('<basepath>', $this->base_dir, $cp['to']));
287 $cp['from'] = clean_path(str_replace('<basepath>', $this->base_dir, $cp['from']));
288 $GLOBALS['log']->debug('Unlink ' . $cp['to']);
289 /* BEGIN - RESTORE POINT - by MR. MILK August 31, 2005 02:22:11 PM */
290 //rmdir_recursive($cp['to']);
292 $backup_path = clean_path( remove_file_extension(urldecode(hashToFile($_REQUEST['install_file'])))."-restore/".$cp['to'] );
293 $this->uninstall_new_files($cp, $backup_path);
294 $this->copy_path($backup_path, $cp['to'], $backup_path, true);
295 /* END - RESTORE POINT - by MR. MILK August 31, 2005 02:22:18 PM */
297 $backup_path = clean_path( remove_file_extension(urldecode(hashToFile($_REQUEST['install_file'])))."-restore");
298 if(file_exists($backup_path))
299 rmdir_recursive($backup_path);
305 * Removes any files that were added by the loaded module. If the files already existed prior to install
306 * it will be handled by copy_path with the uninstall parameter.
309 function uninstall_new_files($cp, $backup_path){
310 $zip_files = $this->dir_get_files($cp['from'],$cp['from']);
311 $backup_files = $this->dir_get_files($backup_path, $backup_path);
312 foreach($zip_files as $k=>$v){
313 //if it's not a backup then it is probably a new file but we'll check that it is not in the md5.files first
314 if(!isset($backup_files[$k])){
315 $to = $cp['to'] . $k;
316 //if it's not a sugar file then we remove it otherwise we can't restor it
317 if(!$this->ms->sugarFileExists($to)){
318 $GLOBALS['log']->debug('ModuleInstaller[uninstall_new_file] deleting file ' . $to);
319 if(file_exists($to)) {
323 $GLOBALS['log']->fatal('ModuleInstaller[uninstall_new_file] Could not remove file ' . $to . ' as no backup file was found to restore to');
327 //lets check if the directory is empty if it is we will delete it as well
328 $files_remaining = $this->dir_file_count($cp['to']);
329 if(file_exists($cp['to']) && $files_remaining == 0){
330 $GLOBALS['log']->debug('ModuleInstaller[uninstall_new_file] deleting directory ' . $cp['to']);
331 rmdir_recursive($cp['to']);
337 * Get directory where module's extensions go
338 * @param string $module Module name
340 public function getExtDir($module)
342 if($module == 'application') {
343 return "custom/Extension/application/Ext";
345 return "custom/Extension/modules/$module/Ext";
350 * Install file(s) into Ext/ part
351 * @param string $section Name of the install file section
352 * @param string $extname Name in Ext directory
353 * @param string $module This extension belongs to a specific module
355 public function installExt($section, $extname, $module = '')
357 if(isset($this->installdefs[$section])){
358 $this->log(sprintf(translate("LBL_MI_IN_EXT"), $section));
359 foreach($this->installdefs[$section] as $item){
360 if(isset($item['from'])) {
361 $from = str_replace('<basepath>', $this->base_dir, $item['from']);
365 if(!empty($module)) {
366 $item['to_module'] = $module;
368 $GLOBALS['log']->debug("Installing section $section from $from for " .$item['to_module'] );
369 if($item['to_module'] == 'application') {
370 $path = "custom/Extension/application/Ext/$extname";
372 $path = "custom/Extension/modules/{$item['to_module']}/Ext/$extname";
374 if(!file_exists($path)){
375 mkdir_recursive($path, true);
377 if(isset($item["name"])) {
378 $target = $item["name"];
379 } else if (!empty($from)){
380 $target = basename($from, ".php");
382 $target = $this->id_name;
385 copy_recursive($from , "$path/$target.php");
392 * Uninstall file(s) into Ext/ part
393 * @param string $section Name of the install file section
394 * @param string $extname Name in Ext directory
395 * @param string $module This extension belongs to a specific module
397 public function uninstallExt($section, $extname, $module = '')
399 if(isset($this->installdefs[$section])){
400 $this->log(sprintf(translate("LBL_MI_UN_EXT"), $section));
401 foreach($this->installdefs[$section] as $item){
402 if(isset($item['from'])) {
403 $from = str_replace('<basepath>', $this->base_dir, $item['from']);
407 if(!empty($module)) {
408 $item['to_module'] = $module;
410 $GLOBALS['log']->debug("Uninstalling section $section from $from for " .$item['to_module'] );
411 if($item['to_module'] == 'application') {
412 $path = "custom/Extension/application/Ext/$extname";
414 $path = "custom/Extension/modules/{$item['to_module']}/Ext/$extname";
416 if(isset($item["name"])) {
417 $target = $item["name"];
418 } else if (!empty($from)){
419 $target = basename($from, ".php");
421 $target = $this->id_name;
423 $disabled_path = $path.'/'.DISABLED_PATH;
424 if (file_exists("$path/$target.php")) {
425 rmdir_recursive("$path/$target.php");
426 } else if (file_exists("$disabled_path/$target.php")) {
427 rmdir_recursive("$disabled_path/$target.php");
428 } else if (!empty($from) && file_exists($path . '/'. basename($from))) {
429 rmdir_recursive( $path . '/'. basename($from));
430 } else if (!empty($from) && file_exists($disabled_path . '/'. basename($from))) {
431 rmdir_recursive( $disabled_path . '/'. basename($from));
438 * Rebuild generic extension
439 * @param string $ext Extension directory
440 * @param string $filename Target filename
442 public function rebuildExt($ext, $filename)
444 $this->log(translate('LBL_MI_REBUILDING') . " $ext...");
445 $this->merge_files("Ext/$ext/", $filename);
449 * Disable generic extension
450 * @param string $section Install file section name
451 * @param string $extname Extension directory
452 * @param string $module This extension belongs to a specific module
454 public function disableExt($section, $extname, $module = '')
456 if(isset($this->installdefs[$section])) {
457 foreach($this->installdefs[$section] as $item) {
458 if(isset($item['from'])) {
459 $from = str_replace('<basepath>', $this->base_dir, $item['from']);
463 if(!empty($module)) {
464 $item['to_module'] = $module;
466 $GLOBALS['log']->debug("Disabling $extname ... from $from for " .$item['to_module']);
467 if($item['to_module'] == 'application') {
468 $path = "custom/Extension/application/Ext/$extname";
470 $path = "custom/Extension/modules/{$item['to_module']}/Ext/$extname";
472 if(isset($item["name"])) {
473 $target = $item["name"];
474 } else if (!empty($from)){
475 $target = basename($from, ".php");
477 $target = $this->id_name;
479 $disabled_path = $path.'/'.DISABLED_PATH;
480 if (file_exists("$path/$target.php")) {
481 mkdir_recursive($disabled_path, true);
482 rename("$path/$target.php", "$disabled_path/$target.php");
483 } else if (!empty($from) && file_exists($path . '/'. basename($from))) {
484 mkdir_recursive($disabled_path, true);
485 rename( $path . '/'. basename($from), $disabled_path.'/'. basename($from));
492 * Enable generic extension
493 * @param string $section Install file section name
494 * @param string $extname Extension directory
495 * @param string $module This extension belongs to a specific module
497 public function enableExt($section, $extname, $module = '')
499 if(isset($this->installdefs[$section])) {
500 foreach($this->installdefs[$section] as $item) {
501 if(isset($item['from'])) {
502 $from = str_replace('<basepath>', $this->base_dir, $item['from']);
506 if(!empty($module)) {
507 $item['to_module'] = $module;
509 $GLOBALS['log']->debug("Enabling $extname ... from $from for " .$item['to_module']);
511 if($item['to_module'] == 'application') {
512 $path = "custom/Extension/application/Ext/$extname";
514 $path = "custom/Extension/modules/{$item['to_module']}/Ext/$extname";
516 if(isset($item["name"])) {
517 $target = $item["name"];
518 } else if (!empty($from)){
519 $target = basename($from, ".php");
521 $target = $this->id_name;
523 if(!file_exists($path)) {
524 mkdir_recursive($path, true);
526 $disabled_path = $path.'/'.DISABLED_PATH;
527 if (file_exists("$disabled_path/$target.php")) {
528 rename("$disabled_path/$target.php", "$path/$target.php");
530 if (!empty($from) && file_exists($disabled_path . '/'. basename($from))) {
531 rename($disabled_path.'/'. basename($from), $path . '/'. basename($from));
537 public function install_extensions()
539 foreach($this->extensions as $extname => $ext) {
540 $install = "install_$extname";
541 if(method_exists($this, $install)) {
542 // non-standard function
545 if(!empty($ext["section"])) {
546 $module = isset($ext['module'])?$ext['module']:'';
547 $this->installExt($ext["section"], $ext["extdir"], $module);
551 $this->rebuild_extensions();
554 public function uninstall_extensions()
556 foreach($this->extensions as $extname => $ext) {
557 $func = "uninstall_$extname";
558 if(method_exists($this, $func)) {
559 // non-standard function
562 if(!empty($ext["section"])) {
563 $module = isset($ext['module'])?$ext['module']:'';
564 $this->uninstallExt($ext["section"], $ext["extdir"], $module);
568 $this->rebuild_extensions();
571 public function rebuild_extensions()
573 foreach($this->extensions as $extname => $ext) {
574 $func = "rebuild_$extname";
575 if(method_exists($this, $func)) {
576 // non-standard function
579 $this->rebuildExt($ext["extdir"], $ext["file"]);
584 public function disable_extensions()
586 foreach($this->extensions as $extname => $ext) {
587 $func = "disable_$extname";
588 if(method_exists($this, $func)) {
589 // non-standard install
592 if(!empty($ext["section"])) {
593 $module = isset($ext['module'])?$ext['module']:'';
594 $this->disableExt($ext["section"], $ext["extdir"], $module);
598 $this->rebuild_extensions();
601 public function enable_extensions()
603 foreach($this->extensions as $extname => $ext) {
604 $func = "enable_$extname";
605 if(method_exists($this, $func)) {
606 // non-standard install
609 if(!empty($ext["section"])) {
610 $module = isset($ext['module'])?$ext['module']:'';
611 $this->enableExt($ext["section"], $ext["extdir"], $module);
615 $this->rebuild_extensions();
618 function install_dashlets()
620 if(isset($this->installdefs['dashlets'])){
621 foreach($this->installdefs['dashlets'] as $cp){
622 $this->log(translate('LBL_MI_IN_DASHLETS') . $cp['name']);
623 $cp['from'] = str_replace('<basepath>', $this->base_dir, $cp['from']);
624 $path = 'custom/modules/Home/Dashlets/' . $cp['name'] . '/';
625 $GLOBALS['log']->debug("Installing Dashlet " . $cp['name'] . "..." . $cp['from'] );
626 if(!file_exists($path)){
627 mkdir_recursive($path, true);
629 copy_recursive($cp['from'] , $path);
631 include('modules/Administration/RebuildDashlets.php');
636 function uninstall_dashlets(){
637 if(isset($this->installdefs['dashlets'])){
638 foreach($this->installdefs['dashlets'] as $cp){
639 $this->log(translate('LBL_MI_UN_DASHLETS') . $cp['name']);
640 $path = 'custom/modules/Home/Dashlets/' . $cp['name'];
641 $GLOBALS['log']->debug('Unlink ' .$path);
642 if (file_exists($path))
643 rmdir_recursive($path);
645 include('modules/Administration/RebuildDashlets.php');
650 function install_images(){
651 if(isset($this->installdefs['image_dir'])){
652 $this->log( translate('LBL_MI_IN_IMAGES') );
653 $this->copy_path($this->installdefs['image_dir'] , 'custom/themes');
658 function install_dcactions(){
659 if(isset($this->installdefs['dcaction'])){
660 $this->log(translate('LBL_MI_IN_MENUS'));
661 foreach($this->installdefs['dcaction'] as $action){
662 $action['from'] = str_replace('<basepath>', $this->base_dir, $action['from']);
663 $GLOBALS['log']->debug("Installing DCActions ..." . $action['from']);
664 $path = 'custom/Extension/application/Ext/DashletContainer/Containers';
665 if(!file_exists($path)){
666 mkdir_recursive($path, true);
668 copy_recursive($action['from'] , $path . '/'. $this->id_name . '.php');
670 $this->rebuild_dashletcontainers();
674 function uninstall_dcactions(){
675 if(isset($this->installdefs['dcaction'])){
676 $this->log(translate('LBL_MI_UN_MENUS'));
677 foreach($this->installdefs['dcaction'] as $action){
678 $action['from'] = str_replace('<basepath>', $this->base_dir, $action['from']);
679 $GLOBALS['log']->debug("Uninstalling DCActions ..." . $action['from'] );
680 $path = 'custom/Extension/application/Ext/DashletContainer/Containers';
681 if (sugar_is_file($path . '/'. $this->id_name . '.php', 'w'))
683 rmdir_recursive( $path . '/'. $this->id_name . '.php');
685 else if (sugar_is_file($path . '/'. DISABLED_PATH . '/'. $this->id_name . '.php', 'w'))
687 rmdir_recursive( $path . '/'. DISABLED_PATH . '/'. $this->id_name . '.php');
690 $this->rebuild_dashletcontainers();
694 function install_connectors(){
695 if(isset($this->installdefs['connectors'])){
696 foreach($this->installdefs['connectors'] as $cp){
697 $this->log(translate('LBL_MI_IN_CONNECTORS') . $cp['name']);
698 $dir = str_replace('_','/',$cp['name']);
699 $cp['connector'] = str_replace('<basepath>', $this->base_dir, $cp['connector']);
700 $source_path = 'custom/modules/Connectors/connectors/sources/' . $dir. '/';
701 $GLOBALS['log']->debug("Installing Connector " . $cp['name'] . "..." . $cp['connector'] );
702 if(!file_exists($source_path)){
703 mkdir_recursive($source_path, true);
705 copy_recursive($cp['connector'] , $source_path);
707 //Install optional formatter code if it is specified
708 if(!empty($cp['formatter'])) {
709 $cp['formatter'] = str_replace('<basepath>', $this->base_dir, $cp['formatter']);
710 $formatter_path = 'custom/modules/Connectors/connectors/formatters/' . $dir. '/';
711 if(!file_exists($formatter_path)){
712 mkdir_recursive($formatter_path, true);
714 copy_recursive($cp['formatter'] , $formatter_path);
717 require_once('include/connectors/utils/ConnectorUtils.php');
718 ConnectorUtils::installSource($cp['name']);
722 function uninstall_connectors(){
723 if(isset($this->installdefs['connectors'])){
724 foreach($this->installdefs['connectors'] as $cp){
725 $this->log(translate('LBL_MI_UN_CONNECTORS') . $cp['name']);
726 $dir = str_replace('_','/',$cp['name']);
727 $source_path = 'custom/modules/Connectors/connectors/sources/' . $dir;
728 $formatter_path = 'custom/modules/Connectors/connectors/formatters/' . $dir;
729 $GLOBALS['log']->debug('Unlink ' .$source_path);
730 rmdir_recursive($source_path);
731 rmdir_recursive($formatter_path);
733 require_once('include/connectors/utils/ConnectorUtils.php');
734 //ConnectorUtils::getConnectors(true);
735 ConnectorUtils::uninstallSource($cp['name']);
739 function install_vardef($from, $to_module)
741 $GLOBALS['log']->debug("Installing Vardefs ..." . $from . " for " .$to_module);
742 $path = 'custom/Extension/modules/' . $to_module. '/Ext/Vardefs';
743 if($to_module == 'application'){
744 $path ='custom/Extension/' . $to_module. '/Ext/Vardefs';
746 if(!file_exists($path)){
747 mkdir_recursive($path, true);
749 copy_recursive($from , $path.'/'. basename($from));
752 function install_layoutdef($from, $to_module){
753 $GLOBALS['log']->debug("Installing Layout Defs ..." . $from . " for " .$to_module);
754 $path = 'custom/Extension/modules/' . $to_module. '/Ext/Layoutdefs';
755 if($to_module == 'application'){
756 $path ='custom/Extension/' . $to_module. '/Ext/Layoutdefs';
758 if(!file_exists($path)){
759 mkdir_recursive($path, true);
761 copy_recursive($from , $path.'/'. basename($from));
764 // Non-standard - needs special rebuild call
765 function install_languages()
767 $languages = array();
768 if(isset($this->installdefs['language']))
770 $this->log(translate('LBL_MI_IN_LANG') );
771 foreach($this->installdefs['language'] as $packs)
773 $modules[]=$packs['to_module'];
774 $languages[$packs['language']] = $packs['language'];
775 $packs['from'] = str_replace('<basepath>', $this->base_dir, $packs['from']);
776 $GLOBALS['log']->debug("Installing Language Pack ..." . $packs['from'] . " for " .$packs['to_module']);
777 $path = 'custom/Extension/modules/' . $packs['to_module']. '/Ext/Language';
778 if($packs['to_module'] == 'application'){
779 $path ='custom/Extension/' . $packs['to_module']. '/Ext/Language';
782 if(!file_exists($path)){
783 mkdir_recursive($path, true);
785 copy_recursive($packs['from'] , $path.'/'.$packs['language'].'.'. $this->id_name . '.php');
787 $this->rebuild_languages($languages, $modules);
792 // Non-standard, needs special rebuild
793 function uninstall_languages(){
794 $languages = array();
795 if(isset($this->installdefs['language'])){
796 $this->log(translate('LBL_MI_UN_LANG') );
797 foreach($this->installdefs['language'] as $packs){
798 $modules[]=$packs['to_module'];
799 $languages[$packs['language']] = $packs['language'];
800 $packs['from'] = str_replace('<basepath>', $this->base_dir, $packs['from']);
801 $GLOBALS['log']->debug("Uninstalling Language Pack ..." . $packs['from'] . " for " .$packs['to_module']);
802 $path = 'custom/Extension/modules/' . $packs['to_module']. '/Ext/Language';
803 if($packs['to_module'] == 'application'){
804 $path ='custom/Extension/' . $packs['to_module']. '/Ext/Language';
806 if (sugar_is_file($path.'/'.$packs['language'].'.'. $this->id_name . '.php', 'w')) {
807 rmdir_recursive( $path.'/'.$packs['language'].'.'. $this->id_name . '.php');
808 } else if (sugar_is_file($path.'/'.DISABLED_PATH.'/'.$packs['language'].'.'. $this->id_name . '.php', 'w')) {
809 rmdir_recursive($path.'/'.DISABLED_PATH.'/'.$packs['language'].'.'. $this->id_name . '.php', 'w');
812 $this->rebuild_languages($languages, $modules);
817 // Non-standard, needs special rebuild
818 public function disable_languages()
820 if(isset($this->installdefs['language'])) {
821 $languages = $modules = array();
822 foreach($this->installdefs['language'] as $item) {
823 $from = str_replace('<basepath>', $this->base_dir, $item['from']);
824 $GLOBALS['log']->debug("Disabling Language {$item['language']}... from $from for " .$item['to_module']);
825 $modules[]=$item['to_module'];
826 $languages[$item['language']] = $item['language'];
827 if($item['to_module'] == 'application') {
828 $path = "custom/Extension/application/Ext/Language";
830 $path = "custom/Extension/modules/{$item['to_module']}/Ext/Language";
832 if(isset($item["name"])) {
833 $target = $item["name"];
835 $target = $this->id_name;
837 $target = "{$item['language']}.$target";
839 $disabled_path = $path.'/'.DISABLED_PATH;
840 if (file_exists("$path/$target.php")) {
841 mkdir_recursive($disabled_path, true);
842 rename("$path/$target.php", "$disabled_path/$target.php");
843 } else if (file_exists($path . '/'. basename($from))) {
844 mkdir_recursive($disabled_path, true);
845 rename( $path . '/'. basename($from), $disabled_path.'/'. basename($from));
848 $this->rebuild_languages($languages, $modules);
852 // Non-standard, needs special rebuild
853 public function enable_languages()
855 if(isset($this->installdefs['language'])) {
856 foreach($this->installdefs['language'] as $item) {
857 $from = str_replace('<basepath>', $this->base_dir, $item['from']);
858 $GLOBALS['log']->debug("Enabling Language {$item['language']}... from $from for " .$item['to_module']);
859 $modules[]=$item['to_module'];
860 $languages[$item['language']] = $item['language'];
861 if(!empty($module)) {
862 $item['to_module'] = $module;
865 if($item['to_module'] == 'application') {
866 $path = "custom/Extension/application/Ext/Language";
868 $path = "custom/Extension/modules/{$item['to_module']}/Ext/Language";
870 if(isset($item["name"])) {
871 $target = $item["name"];
873 $target = $this->id_name;
875 $target = "{$item['language']}.$target";
877 if(!file_exists($path)) {
878 mkdir_recursive($path, true);
880 $disabled_path = $path.'/'.DISABLED_PATH;
881 if (file_exists("$disabled_path/$target.php")) {
882 rename("$disabled_path/$target.php", "$path/$target.php");
884 if (file_exists($disabled_path . '/'. basename($from))) {
885 rename($disabled_path.'/'. basename($from), $path . '/'. basename($from));
888 $this->rebuild_languages($languages, $modules);
892 // Functions for adding and removing logic hooks from uploaded files
893 // Since one class/file can be used by multiple logic hooks, I'm not going to touch the file labeled in the logic_hook entry
894 /* The module hook definition should look like this:
895 $installdefs = array(
897 'logic_hooks' => array(
898 array('module' => 'Accounts',
899 'hook' => 'after_save',
901 'description' => 'Account sample logic hook',
902 'file' => 'modules/Sample/sample_account_logic_hook_file.php',
903 'class' => 'SampleLogicClass',
904 'function' => 'accountAfterSave',
910 function enable_manifest_logichooks() {
911 if(empty($this->installdefs['logic_hooks']) || !is_array($this->installdefs['logic_hooks'])) {
917 foreach($this->installdefs['logic_hooks'] as $hook ) {
918 check_logic_hook_file($hook['module'], $hook['hook'], array($hook['order'], $hook['description'], $hook['file'], $hook['class'], $hook['function']));
922 function disable_manifest_logichooks() {
923 if(empty($this->installdefs['logic_hooks']) || !is_array($this->installdefs['logic_hooks'])) {
927 foreach($this->installdefs['logic_hooks'] as $hook ) {
928 remove_logic_hook($hook['module'], $hook['hook'], array($hook['order'], $hook['description'], $hook['file'], $hook['class'], $hook['function']));
932 /* BEGIN - RESTORE POINT - by MR. MILK August 31, 2005 02:22:18 PM */
933 function copy_path($from, $to, $backup_path='', $uninstall=false){
934 //function copy_path($from, $to){
935 /* END - RESTORE POINT - by MR. MILK August 31, 2005 02:22:18 PM */
936 $to = str_replace('<basepath>', $this->base_dir, $to);
939 $from = str_replace('<basepath>', $this->base_dir, $from);
940 $GLOBALS['log']->debug('Copy ' . $from);
943 $from = str_replace('<basepath>', $backup_path, $from);
944 //$GLOBALS['log']->debug('Restore ' . $from);
946 $from = clean_path($from);
947 $to = clean_path($to);
950 //there are cases where if we need to create a directory in the root directory
951 if($dir == '.' && is_dir($from)){
954 if(!sugar_is_dir($dir, 'instance'))
955 mkdir_recursive($dir, true);
956 /* BEGIN - RESTORE POINT - by MR. MILK August 31, 2005 02:22:18 PM */
957 if(empty($backup_path)) {
958 /* END - RESTORE POINT - by MR. MILK August 31, 2005 02:22:18 PM */
959 if(!copy_recursive($from, $to)){
960 die('Failed to copy ' . $from. ' ' . $to);
962 /* BEGIN - RESTORE POINT - by MR. MILK August 31, 2005 02:22:18 PM */
964 elseif(!$this->copy_recursive_with_backup($from, $to, $backup_path, $uninstall)){
965 die('Failed to copy ' . $from. ' to ' . $to);
967 /* END - RESTORE POINT - by MR. MILK August 31, 2005 02:22:18 PM */
970 function install_custom_fields($fields){
971 global $beanList, $beanFiles;
972 include('include/modules.php');
973 require_once('modules/DynamicFields/FieldCases.php');
974 foreach($fields as $field){
976 if(isset($beanList[ $field['module']])){
977 $class = $beanList[ $field['module']];
978 if(!isset($field['ext4']))$field['ext4'] = '';
979 if(!isset($field['mass_update']))$field['mass_update'] = 0;
980 if(!isset($field['duplicate_merge']))$field['duplicate_merge'] = 0;
981 if(!isset($field['help']))$field['help'] = '';
983 //Merge contents of the sugar field extension if we copied one over
984 if (file_exists("custom/Extension/modules/{$field['module']}/Ext/Vardefs/sugarfield_{$field['name']}.php"))
986 $dictionary = array();
987 include ("custom/Extension/modules/{$field['module']}/Ext/Vardefs/sugarfield_{$field['name']}.php");
988 $obj = BeanFactory::getObjectName($field['module']);
989 if (!empty($dictionary[$obj]['fields'][$field['name']])) {
990 $field = array_merge($dictionary[$obj]['fields'][$field['name']], $field);
994 if(file_exists($beanFiles[$class])){
995 require_once($beanFiles[$class]);
998 $fieldObject = get_widget($field['type']);
999 $fieldObject->populateFromRow($field);
1000 $mod->custom_fields->use_existing_labels = true;
1001 $mod->custom_fields->addFieldObject($fieldObject);
1005 $GLOBALS['log']->debug('Could not install custom field ' . $field['name'] . ' for module ' . $field['module'] . ': Module does not exist');
1010 function uninstall_custom_fields($fields){
1011 global $beanList, $beanFiles;
1012 require_once('modules/DynamicFields/DynamicField.php');
1013 $dyField = new DynamicField();
1015 foreach($fields as $field){
1016 $class = $beanList[ $field['module']];
1017 if(file_exists($beanFiles[$class])){
1018 require_once($beanFiles[$class]);
1019 $mod = new $class();
1020 $dyField->bean = $mod;
1021 $dyField->module = $field['module'];
1022 $dyField->deleteField($field['name']);
1028 * ModuleInstaller->install_relationships calls install_relationship for every file included in the module package that defines a relationship, and then
1029 * writes a custom/Extension/application/Ext/TableDictionary/$module.php file containing an include_once for every relationship metadata file passed to install_relationship.
1030 * Next it calls install_vardef and install_layoutdef. Finally, it rebuilds the vardefs and layoutdefs (by calling merge_files as usual), and then calls merge_files to merge
1031 * everything in 'Ext/TableDictionary/' into 'tabledictionary.ext.php'
1033 function install_relationships ()
1035 if (isset ( $this->installdefs [ 'relationships' ] ))
1037 $this->log ( translate ( 'LBL_MI_IN_RELATIONSHIPS' ) ) ;
1038 $str = "<?php \n //WARNING: The contents of this file are auto-generated\n" ;
1039 $save_table_dictionary = false ;
1041 if (! file_exists ( "custom/Extension/application/Ext/TableDictionary" ))
1043 mkdir_recursive ( "custom/Extension/application/Ext/TableDictionary", true ) ;
1046 foreach ( $this->installdefs [ 'relationships' ] as $key => $relationship )
1048 $filename = basename ( $relationship [ 'meta_data' ] ) ;
1049 $this->copy_path ( $relationship [ 'meta_data' ], 'custom/metadata/' . $filename ) ;
1050 $this->install_relationship ( 'custom/metadata/' . $filename ) ;
1051 $save_table_dictionary = true ;
1053 if (! empty ( $relationship [ 'module_vardefs' ] ))
1055 $relationship [ 'module_vardefs' ] = str_replace ( '<basepath>', $this->base_dir, $relationship [ 'module_vardefs' ] ) ;
1056 $this->install_vardef ( $relationship [ 'module_vardefs' ], $relationship [ 'module' ] ) ;
1059 if (! empty ( $relationship [ 'module_layoutdefs' ] ))
1061 $relationship [ 'module_layoutdefs' ] = str_replace ( '<basepath>', $this->base_dir, $relationship [ 'module_layoutdefs' ] ) ;
1062 $this->install_layoutdef ( $relationship [ 'module_layoutdefs' ], $relationship [ 'module' ] ) ;
1065 $relName = strpos($filename, "MetaData") !== false ? substr($filename, 0, strlen($filename) - 12) : $filename;
1066 $out = sugar_fopen ( "custom/Extension/application/Ext/TableDictionary/$relName.php", 'w' ) ;
1067 fwrite ( $out, $str . "include('custom/metadata/$filename');\n\n?>" ) ;
1074 Relationship::delete_cache();
1075 $this->rebuild_vardefs () ;
1076 $this->rebuild_layoutdefs () ;
1077 if ($save_table_dictionary)
1079 $this->rebuild_tabledictionary () ;
1081 require_once("data/Relationships/RelationshipFactory.php");
1082 SugarRelationshipFactory::deleteCache();
1087 * Install_relationship obtains a set of relationship definitions from the filename passed in as a parameter.
1088 * For each definition it calls db->createTableParams to build the relationships table if it does not exist,
1089 * and SugarBean::createRelationshipMeta to add the relationship into the 'relationships' table.
1091 function install_relationship($file)
1093 $_REQUEST['moduleInstaller'] = true;
1094 if(!file_exists($file))
1096 $GLOBALS['log']->debug( 'File does not exists : '.$file);
1100 $rel_dictionary = $dictionary;
1101 foreach ($rel_dictionary as $rel_name => $rel_data)
1103 $table = ''; // table is actually optional
1104 // check if we have a table definition - not all relationships require a join table
1105 if ( isset( $rel_data[ 'table' ] ) )
1107 $table = $rel_data[ 'table' ];
1109 if(!$this->db->tableExists($table))
1111 $this->db->createTableParams($table, $rel_data[ 'fields' ], $rel_data[ 'indices' ]);
1116 $GLOBALS['log']->debug("Processing relationship meta for ". $rel_name."...");
1117 SugarBean::createRelationshipMeta($rel_name, $this->db,$table,$rel_dictionary,'');
1118 Relationship::delete_cache();
1120 $GLOBALS['log']->debug( 'done<br>');
1124 function install_layoutfields() {
1125 if (!empty ( $this->installdefs [ 'layoutfields' ] ))
1127 foreach ( $this->installdefs [ 'layoutfields' ] as $fieldSet )
1129 if (!empty($fieldSet['additional_fields']))
1131 $this->addFieldsToLayout($fieldSet['additional_fields']);
1137 function uninstall_layoutfields() {
1138 if (!empty ( $this->installdefs [ 'layoutfields' ] ))
1140 foreach ( $this->installdefs [ 'layoutfields' ] as $fieldSet )
1142 if (!empty($fieldSet['additional_fields']))
1144 $this->removeFieldsFromLayout($fieldSet['additional_fields']);
1150 function uninstall_relationship($file, $rel_dictionary = null){
1151 if ($rel_dictionary == null)
1153 if(!file_exists($file)){
1154 $GLOBALS['log']->debug( 'File does not exists : '.$file);
1158 $rel_dictionary = $dictionary;
1161 foreach ($rel_dictionary as $rel_name => $rel_data)
1163 if (!empty($rel_data['table'])){
1164 $table = $rel_data['table'];
1167 $table = ' One-to-Many ';
1170 if ($this->db->tableExists($table) && isset($GLOBALS['mi_remove_tables']) && $GLOBALS['mi_remove_tables'])
1172 SugarBean::removeRelationshipMeta($rel_name, $this->db,$table,$rel_dictionary,'');
1173 $this->db->dropTableName($table);
1174 if(!$this->silent) $this->log( translate('LBL_MI_UN_RELATIONSHIPS_DROP') . $table);
1177 //Delete Layout defs
1178 // check to see if we have any vardef or layoutdef entries to remove - must have a relationship['module'] parameter if we do
1179 if (!isset($rel_data[ 'module' ]))
1181 $rel_data['relationships'][$rel_name]['lhs_module'],
1182 $rel_data['relationships'][$rel_name]['rhs_module'],
1185 $mods = array($rel_data[ 'module' ]);
1187 $filename = "$rel_name.php";
1189 foreach($mods as $mod) {
1190 if ($mod != 'application' ) {
1191 $basepath = "custom/Extension/modules/$mod/Ext/";
1193 $basepath = "custom/Extension/application/Ext/";
1196 foreach (array($filename , "custom" . $filename, $rel_name ."_". $mod. ".php") as $fn) {
1197 //remove any vardefs
1198 $path = $basepath . "Vardefs/$fn" ;
1199 if (file_exists( $path ))
1200 rmdir_recursive( $path );
1202 //remove any layoutdefs
1203 $path = $basepath . "Layoutdefs/$fn" ;
1204 if( file_exists( $path ))
1206 rmdir_recursive( $path );
1211 foreach (array($filename , "custom" . $filename, $rel_name ."_". $mod. ".php") as $fn) {
1212 // remove the table dictionary extension
1213 if ( file_exists("custom/Extension/application/Ext/TableDictionary/$fn"))
1214 unlink("custom/Extension/application/Ext/TableDictionary/$fn");
1216 if (file_exists("custom/metadata/{$rel_name}MetaData.php"))
1217 unlink( "custom/metadata/{$rel_name}MetaData.php" );
1222 function uninstall_relationships($include_studio_relationships = false){
1223 $relationships = array();
1225 //Find and remove studio created relationships.
1226 global $beanList, $beanFiles, $dictionary;
1227 //Load up the custom relationship definitions.
1228 if(file_exists('custom/application/Ext/TableDictionary/tabledictionary.ext.php')){
1229 include('custom/application/Ext/TableDictionary/tabledictionary.ext.php');
1231 //Find all the relatioships/relate fields involving this module.
1232 $rels_to_remove = array();
1233 foreach($beanList as $mod => $bean) {
1234 //Some modules like cases have a bean name that doesn't match the object name
1235 $bean = BeanFactory::getObjectName($mod);
1236 VardefManager::loadVardef($mod, $bean);
1237 //We can skip modules that are in this package as they will be removed anyhow
1238 if (!in_array($mod, $this->modulesInPackage) && !empty($dictionary[$bean]) && !empty($dictionary[$bean]['fields']))
1240 $field_defs = $dictionary[$bean]['fields'];
1241 foreach($field_defs as $field => $def)
1243 //Weed out most fields first
1244 if (isset ($def['type']))
1246 //Custom relationships created in the relationship editor
1247 if ($def['type'] == "link" && !empty($def['relationship']) && !empty($dictionary[$def['relationship']]))
1249 $rel_name = $def['relationship'];
1251 $rel_def = $dictionary[$rel_name]['relationships'][$rel_name];
1253 //Check against mods to be removed.
1254 foreach($this->modulesInPackage as $removed_mod) {
1255 if ($rel_def['lhs_module'] == $removed_mod || $rel_def['rhs_module'] == $removed_mod )
1257 $dictionary[$rel_name]['from_studio'] = true;
1258 $relationships[$rel_name] = $dictionary[$rel_name];
1262 //Custom "relate" fields created in studio also need to be removed
1263 if ($def['type'] == 'relate' && isset($def['module'])) {
1264 foreach($this->modulesInPackage as $removed_mod) {
1265 if ($def['module'] == $removed_mod)
1267 require_once 'modules/ModuleBuilder/Module/StudioModule.php' ;
1268 $studioMod = new StudioModule ( $mod );
1269 $studioMod->removeFieldFromLayouts( $field );
1270 if (isset($def['custom_module'])) {
1271 require_once ('modules/DynamicFields/DynamicField.php') ;
1272 require_once ($beanFiles [ $bean ]) ;
1273 $seed = new $bean ( ) ;
1274 $df = new DynamicField ( $mod ) ;
1275 $df->setup ( $seed ) ;
1276 //Need to load the entire field_meta_data for some field types
1277 $field_obj = $df->getFieldWidget($mod, $field);
1278 $field_obj->delete ( $df ) ;
1290 $this->uninstall_relationship(null, $relationships);
1292 if(isset($this->installdefs['relationships'])) {
1293 $relationships = $this->installdefs['relationships'];
1294 $this->log(translate('LBL_MI_UN_RELATIONSHIPS') );
1295 foreach($relationships as $relationship)
1297 // remove the metadata entry
1298 $filename = basename ( $relationship['meta_data'] );
1299 $pathname = (file_exists("custom/metadata/$filename")) ? "custom/metadata/$filename" : "metadata/$filename" ;
1300 if(isset($GLOBALS['mi_remove_tables']) && $GLOBALS['mi_remove_tables'])
1301 $this->uninstall_relationship( $pathname );
1302 if (file_exists($pathname))
1303 unlink( $pathname );
1307 if (file_exists("custom/Extension/application/Ext/TableDictionary/{$this->id_name}.php"))
1308 unlink("custom/Extension/application/Ext/TableDictionary/{$this->id_name}.php");
1309 Relationship::delete_cache();
1310 $this->rebuild_tabledictionary();
1316 function uninstall($base_dir){
1317 if(defined('TEMPLATE_URL'))SugarTemplateUtilities::disableCache();
1318 global $app_strings;
1319 $total_steps = 5; //min steps with no tasks
1321 $this->base_dir = $base_dir;
1324 'uninstall_relationships',
1326 'uninstall_dcactions',
1327 'uninstall_dashlets',
1328 'uninstall_connectors',
1329 'uninstall_layoutfields',
1330 'uninstall_extensions',
1331 'disable_manifest_logichooks',
1334 $total_steps += count($tasks); //now the real number of steps
1335 if(file_exists($this->base_dir . '/manifest.php')){
1338 display_progress_bar('install', $current_step, $total_steps);
1339 echo '<div id ="displayLoglink" ><a href="#" onclick="toggleDisplay(\'displayLog\')">'.$app_strings['LBL_DISPLAY_LOG'].'</a> </div><div id="displayLog" style="display:none">';
1343 include($this->base_dir . '/manifest.php');
1344 $this->installdefs = $installdefs;
1345 $this->id_name = $this->installdefs['id'];
1346 $installed_modules = array();
1347 if(isset($this->installdefs['beans'])){
1348 foreach($this->installdefs['beans'] as $bean){
1350 $installed_modules[] = $bean['module'];
1351 $this->uninstall_user_prefs($bean['module']);
1353 $this->modulesInPackage = $installed_modules;
1354 $this->uninstall_beans($installed_modules);
1355 $this->uninstall_customizations($installed_modules);
1358 update_progress_bar('install', $total_steps, $total_steps);
1363 update_progress_bar('install', $current_step, $total_steps);
1365 foreach($tasks as $task){
1369 update_progress_bar('install', $current_step, $total_steps);
1372 if(isset($installdefs['custom_fields']) && (isset($GLOBALS['mi_remove_tables']) && $GLOBALS['mi_remove_tables'])){
1373 $this->log(translate('LBL_MI_UN_CUSTOMFIELD'));
1374 $this->uninstall_custom_fields($installdefs['custom_fields']);
1378 update_progress_bar('install', $current_step, $total_steps);
1381 //since we are passing $silent = true to rebuildAll() in that method it will set $this->silent = true, so
1382 //we need to save the setting to set it back after rebuildAll() completes.
1383 $silentBak = $this->silent;
1384 $this->rebuild_all(true);
1385 $this->silent = $silentBak;
1387 //#27877, If the request from MB redeploy a custom module , we will not remove the ACL actions for this package.
1388 if( !isset($_REQUEST['action']) || $_REQUEST['action']!='DeployPackage' ){
1389 $this->remove_acl_actions();
1395 update_progress_bar('install', $current_step, $total_steps);
1399 UpdateSystemTabs('Restore',$installed_modules);
1401 //clear the unified_search_module.php file
1402 require_once('modules/Home/UnifiedSearchAdvanced.php');
1403 UnifiedSearchAdvanced::unlinkUnifiedSearchModulesFile();
1405 $this->log('<br><b>' . translate('LBL_MI_COMPLETE') . '</b>');
1407 update_progress_bar('install', $total_steps, $total_steps);
1410 die("No manifest.php Defined In $this->base_dir/manifest.php");
1414 function rebuild_languages($languages = array(), $modules="")
1416 foreach($languages as $language=>$value){
1417 $this->log(translate('LBL_MI_REBUILDING') . " Language...$language");
1418 $this->merge_files('Ext/Language/', $language.'.lang.ext.php', $language);
1420 foreach($modules as $module){
1421 LanguageManager::clearLanguageCache($module, $language);
1425 sugar_cache_reset();
1428 function rebuild_vardefs()
1430 $this->rebuildExt("Vardefs", 'vardefs.ext.php');
1431 sugar_cache_reset();
1434 function rebuild_dashletcontainers(){
1435 $this->log(translate('LBL_MI_REBUILDING') . " DC Actions...");
1436 $this->merge_files('Ext/DashletContainer/Containers/', 'dcactions.ext.php');
1439 function rebuild_tabledictionary()
1441 $this->rebuildExt("TableDictionary", 'tabledictionary.ext.php');
1444 function rebuild_relationships() {
1445 if(!$this->silent) echo translate('LBL_MI_REBUILDING') . ' Relationships';
1446 $_REQUEST['silent'] = true;
1448 include('include/modules.php');
1449 include("modules/Administration/RebuildRelationship.php");
1452 function remove_acl_actions() {
1453 global $beanFiles, $beanList, $current_user;
1454 include('include/modules.php');
1455 include("modules/ACL/remove_actions.php");
1459 * Wrapper call to modules/Administration/RepairIndex.php
1461 function repair_indices() {
1462 global $current_user,$beanFiles,$dictionary;
1463 $this->log(translate('LBL_MI_REPAIR_INDICES'));
1464 $_REQUEST['silent'] = true; // local var flagging echo'd output in repair script
1465 $_REQUEST['mode'] = 'execute'; // flag to just go ahead and run the script
1466 include("modules/Administration/RepairIndex.php");
1470 * Rebuilds the extension files found in custom/Extension
1471 * @param boolean $silent
1473 function rebuild_all($silent=false){
1474 if(defined('TEMPLATE_URL'))SugarTemplateUtilities::disableCache();
1475 $this->silent=$silent;
1476 global $sugar_config;
1478 //Check for new module extensions
1479 $this->rebuild_modules();
1481 $this->rebuild_languages($sugar_config['languages']);
1482 $this->rebuild_extensions();
1483 $this->rebuild_dashletcontainers();
1484 $this->rebuild_relationships();
1485 $this->rebuild_tabledictionary();
1486 $this->reset_opcodes();
1487 sugar_cache_reset();
1491 * ModuleInstaller->merge_files runs over the list of all modules already installed in /modules. For each $module it reads the contents of every file in
1492 * custom/Extension/modules/$module/<path> (_override files last) and concatenates them to custom/modules/$module/<path>/<file>.
1493 * Then it does the same thing in custom/Extension/application/<path>, concatenating those files and copying the result to custom/application/<path>/<file>
1495 function merge_files($path, $name, $filter = '', $application = false){
1497 $GLOBALS['log']->debug( get_class($this)."->merge_files() : merging module files in custom/Extension/modules/<module>/$path to custom/modules/<module>/$path$name");
1498 foreach($this->modules as $module){
1499 //$GLOBALS['log']->debug("Merging Files for: ".$module);
1500 //$GLOBALS['log']->debug("Merging Files for path: ".$path);
1501 $extension = "<?php \n //WARNING: The contents of this file are auto-generated\n";
1502 $extpath = "modules/$module/$path";
1503 $module_install = 'custom/Extension/'.$extpath;
1504 $shouldSave = false;
1505 if(is_dir($module_install)){
1506 $dir = dir($module_install);
1508 $override = array();
1509 while($entry = $dir->read()){
1510 if((empty($filter) || substr_count($entry, $filter) > 0) && is_file($module_install.'/'.$entry)
1511 && $entry != '.' && $entry != '..' && strtolower(substr($entry, -4)) == ".php")
1513 if (substr($entry, 0, 9) == '_override') {
1514 $override[] = $entry;
1516 $file = file_get_contents($module_install . '/' . $entry);
1517 $GLOBALS['log']->debug(get_class($this)."->merge_files(): found {$module_install}{$entry}") ;
1518 $extension .= "\n". str_replace(array('<?php', '?>', '<?PHP', '<?'), array('','', '' ,'') , $file);
1522 foreach ($override as $entry) {
1523 $file = file_get_contents($module_install . '/' . $entry);
1524 $extension .= "\n". str_replace(array('<?php', '?>', '<?PHP', '<?'), array('','', '' ,'') , $file);
1527 $extension .= "\n?>";
1530 if(!file_exists("custom/$extpath")) {
1531 mkdir_recursive("custom/$extpath", true);
1533 $out = sugar_fopen("custom/$extpath/$name", 'w');
1534 fwrite($out,$extension);
1537 if(file_exists("custom/$extpath/$name")){
1538 unlink("custom/$extpath/$name");
1545 $GLOBALS['log']->debug("Merging application files for $name in $path");
1546 //Now the application stuff
1547 $extension = "<?php \n //WARNING: The contents of this file are auto-generated\n";
1548 $extpath = "application/$path";
1549 $module_install = 'custom/Extension/'.$extpath;
1550 $shouldSave = false;
1551 if(is_dir($module_install)){
1552 $dir = dir($module_install);
1553 while($entry = $dir->read()){
1555 if((empty($filter) || substr_count($entry, $filter) > 0) && is_file($module_install.'/'.$entry)
1556 && $entry != '.' && $entry != '..' && strtolower(substr($entry, -4)) == ".php")
1558 $file = file_get_contents($module_install . '/' . $entry);
1559 $extension .= "\n". str_replace(array('<?php', '?>', '<?PHP', '<?'), array('','', '' ,'') , $file);
1563 $extension .= "\n?>";
1565 if(!file_exists("custom/$extpath")){
1566 mkdir_recursive("custom/$extpath", true);
1568 $out = sugar_fopen("custom/$extpath/$name", 'w');
1569 fwrite($out,$extension);
1572 if(file_exists("custom/$extpath/$name")){
1573 unlink("custom/$extpath/$name");
1579 function install_modules()
1581 $this->installed_modules = array();
1582 $this->tab_modules = array();
1583 if(isset($this->installdefs['beans'])){
1584 $str = "<?php \n //WARNING: The contents of this file are auto-generated\n";
1585 foreach($this->installdefs['beans'] as $bean){
1586 if(!empty($bean['module']) && !empty($bean['class']) && !empty($bean['path'])){
1587 $module = $bean['module'];
1588 $class = $bean['class'];
1589 $path = $bean['path'];
1591 $str .= "\$beanList['$module'] = '$class';\n";
1592 $str .= "\$beanFiles['$class'] = '$path';\n";
1594 $str .= "\$moduleList[] = '$module';\n";
1595 $this->install_user_prefs($module, empty($bean['hide_by_default']));
1596 $this->tab_modules[] = $module;
1598 $str .= "\$modules_exempt_from_availability_check['$module'] = '$module';\n";
1599 $str .= "\$report_include_modules['$module'] = '$module';\n";
1600 $str .= "\$modInvisList[] = '$module';\n";
1602 $this->installed_modules[] = $module;
1604 $errors[] = 'Bean array not well defined.';
1605 $this->abort($errors);
1609 if(!file_exists("custom/Extension/application/Ext/Include")){
1610 mkdir_recursive("custom/Extension/application/Ext/Include", true);
1612 file_put_contents("custom/Extension/application/Ext/Include/{$this->id_name}.php", $str);
1617 * ModuleInstaller->install_beans runs through the list of beans given, instantiates each bean, calls bean->create_tables, and then calls SugarBean::createRelationshipMeta for the
1620 function install_beans($beans){
1621 include('include/modules.php');
1622 foreach($beans as $bean){
1623 $this->log( translate('LBL_MI_IN_BEAN') . " $bean");
1624 if(isset($beanList[$bean])){
1625 $class = $beanList[$bean];
1626 if(file_exists($beanFiles[$class])){
1627 require_once($beanFiles[$class]);
1628 $mod = new $class();
1630 if(is_subclass_of($mod, 'SugarBean') && $mod->disable_vardefs == false ){
1631 $GLOBALS['log']->debug( "Creating Tables Bean : $bean");
1632 $mod->create_tables();
1633 SugarBean::createRelationshipMeta($mod->getObjectName(), $mod->db,$mod->table_name,'',$mod->module_dir);
1636 $GLOBALS['log']->debug( "File Does Not Exist:" . $beanFiles[$class] );
1642 function uninstall_beans($beans){
1643 include('include/modules.php');
1644 foreach($beans as $bean){
1645 $this->log( translate('LBL_MI_UN_BEAN') . " $bean");
1646 if(isset($beanList[$bean])){
1647 $class = $beanList[$bean];
1649 if(file_exists($beanFiles[$class])){
1650 require_once($beanFiles[$class]);
1651 $mod = new $class();
1653 if(is_subclass_of($mod, 'SugarBean')){
1654 $GLOBALS['log']->debug( "Drop Tables : $bean");
1655 if(isset($GLOBALS['mi_remove_tables']) && $GLOBALS['mi_remove_tables'])
1656 $mod->drop_tables();
1659 $GLOBALS['log']->debug( "File Does Not Exist:" . $beanFiles[$class] );
1666 * Remove any customizations made within Studio while the module was installed.
1668 function uninstall_customizations($beans){
1669 foreach($beans as $bean){
1671 'custom/modules/' . $bean,
1672 'custom/Extension/modules/' . $bean,
1673 'custom/working/modules/' . $bean
1675 foreach($dirs as $dir)
1678 rmdir_recursive($dir);
1685 $GLOBALS['log']->debug('ModuleInstaller:'. $str);
1691 /* BEGIN - RESTORE POINT - by MR. MILK August 31, 2005 02:15:18 PM */
1692 function copy_recursive_with_backup( $source, $dest, $backup_path, $uninstall=false ) {
1693 if(is_file($source)) {
1695 $GLOBALS['log']->debug("Restoring ... " . $source. " to " .$dest );
1696 if(copy( $source, $dest)) {
1697 if(is_writable($dest))
1698 sugar_touch( $dest, filemtime($source) );
1699 return(unlink($source));
1702 $GLOBALS['log']->debug( "Can't restore file: " . $source );
1707 if(file_exists($dest)) {
1708 $rest = clean_path($backup_path."/$dest");
1709 if( !is_dir(dirname($rest)) )
1710 mkdir_recursive(dirname($rest), true);
1712 $GLOBALS['log']->debug("Backup ... " . $dest. " to " .$rest );
1713 if(copy( $dest, $rest)) {
1714 if(is_writable($rest))
1715 sugar_touch( $rest, filemtime($dest) );
1718 $GLOBALS['log']->debug( "Can't backup file: " . $dest );
1721 return( copy( $source, $dest ) );
1724 elseif(!is_dir($source)) {
1727 return(unlink($dest));
1729 //don't do anything we already cleaned up the files using uninstall_new_files
1737 if( !is_dir($dest) && !$uninstall){
1738 sugar_mkdir( $dest );
1743 $d = dir( $source );
1744 while( $f = $d->read() ){
1745 if( $f == "." || $f == ".." ){
1748 $status &= $this->copy_recursive_with_backup( "$source/$f", "$dest/$f", $backup_path, $uninstall );
1754 private function dir_get_files($path, $base_path){
1756 if(!is_dir($path))return $files;
1758 while ($e = $d->read()){
1759 //ignore invisible files . .. ._MACOSX
1760 if(substr($e, 0, 1) == '.')continue;
1761 if(is_file($path . '/' . $e))$files[str_replace($base_path , '', $path . '/' . $e)] = str_replace($base_path , '', $path . '/' . $e);
1762 if(is_dir($path . '/' . $e))$files = array_merge($files, $this->dir_get_files($path . '/' . $e, $base_path));
1769 private function dir_file_count($path){
1770 //if its a file then it has at least 1 file in the directory
1771 if(is_file($path)) return 1;
1772 if(!is_dir($path)) return 0;
1775 while ($e = $d->read()){
1776 //ignore invisible files . .. ._MACOSX
1777 if(substr($e, 0, 1) == '.')continue;
1778 if(is_file($path . '/' . $e))$count++;
1779 if(is_dir($path . '/' . $e))$count += $this->dir_file_count($path . '/' . $e);
1786 /* END - RESTORE POINT - by MR. MILK August 31, 2005 02:15:34 PM */
1790 * Static function which allows a module developer to abort their progress, pass in an array of errors and
1791 * redirect back to the main module loader page
1793 * @param errors an array of error messages which will be displayed on the
1794 * main module loader page once it is loaded.
1796 function abort($errors = array()){
1797 //set the errors onto the session so we can display them one the moduler loader page loads
1798 $_SESSION['MODULEINSTALLER_ERRORS'] = $errors;
1799 echo '<META HTTP-EQUIV="Refresh" content="0;url=index.php?module=Administration&action=UpgradeWizard&view=module">';
1801 //header('Location: index.php?module=Administration&action=UpgradeWizard&view=module');
1805 * Return the set of errors stored in the SESSION
1807 * @return an array of errors
1809 function getErrors(){
1810 if(!empty($_SESSION['MODULEINSTALLER_ERRORS'])){
1811 $errors = $_SESSION['MODULEINSTALLER_ERRORS'];
1812 unset($_SESSION['MODULEINSTALLER_ERRORS']);
1820 * Add any fields to the DetailView and EditView of the appropriate modules
1821 * Only add into deployed modules, as addFieldsToUndeployedLayouts has done this already for undeployed modules (and the admin might have edited the layouts already)
1822 * @param array $layoutAdditions An array of module => fieldname
1825 function addFieldsToLayout($layoutAdditions) {
1826 require_once 'modules/ModuleBuilder/parsers/views/GridLayoutMetaDataParser.php' ;
1828 // these modules either lack editviews/detailviews or use custom mechanisms for the editview/detailview.
1829 // In either case, we don't want to attempt to add a relate field to them
1830 // would be better if GridLayoutMetaDataParser could handle this gracefully, so we don't have to maintain this list here
1831 $invalidModules = array ( 'emails' , 'kbdocuments' ) ;
1833 foreach ( $layoutAdditions as $deployedModuleName => $fieldName )
1835 if ( ! in_array( strtolower ( $deployedModuleName ) , $invalidModules ) )
1837 foreach ( array ( MB_EDITVIEW , MB_DETAILVIEW ) as $view )
1839 $GLOBALS [ 'log' ]->debug ( get_class ( $this ) . ": adding $fieldName to $view layout for module $deployedModuleName" ) ;
1840 $parser = new GridLayoutMetaDataParser ( $view, $deployedModuleName ) ;
1841 $parser->addField ( array ( 'name' => $fieldName ) ) ;
1842 $parser->handleSave ( false ) ;
1849 function removeFieldsFromLayout($layoutAdditions) {
1850 require_once 'modules/ModuleBuilder/parsers/views/GridLayoutMetaDataParser.php' ;
1852 // these modules either lack editviews/detailviews or use custom mechanisms for the editview/detailview.
1853 // In either case, we don't want to attempt to add a relate field to them
1854 // would be better if GridLayoutMetaDataParser could handle this gracefully, so we don't have to maintain this list here
1855 $invalidModules = array ( 'emails' , 'kbdocuments' ) ;
1857 foreach ( $layoutAdditions as $deployedModuleName => $fieldName )
1859 if ( ! in_array( strtolower ( $deployedModuleName ) , $invalidModules ) )
1861 foreach ( array ( MB_EDITVIEW , MB_DETAILVIEW ) as $view )
1863 $GLOBALS [ 'log' ]->debug ( get_class ( $this ) . ": adding $fieldName to $view layout for module $deployedModuleName" ) ;
1864 $parser = new GridLayoutMetaDataParser ( $view, $deployedModuleName ) ;
1865 $parser->removeField ( $fieldName ) ;
1866 $parser->handleSave ( false ) ;
1874 //********** DISABLE/ENABLE FUNCTIONS
1876 function enable($base_dir, $is_upgrade = false, $previous_version = ''){
1877 global $app_strings;
1878 $this->base_dir = $base_dir;
1879 $total_steps = 3; //minimum number of steps with no tasks
1884 'enable_relationships',
1885 'enable_extensions',
1886 'enable_manifest_logichooks',
1889 $total_steps += count($tasks);
1890 if(file_exists($this->base_dir . '/manifest.php')){
1893 display_progress_bar('install', $current_step, $total_steps);
1894 echo '<div id ="displayLoglink" ><a href="#" onclick="toggleDisplay(\'displayLog\')">'.$app_strings['LBL_DISPLAY_LOG'].'</a> </div><div id="displayLog" style="display:none">';
1897 require_once($this->base_dir . '/manifest.php');
1898 if($is_upgrade && !empty($previous_version)){
1899 //check if the upgrade path exists
1900 if(!empty($upgrade_manifest)){
1901 if(!empty($upgrade_manifest['upgrade_paths'])){
1902 if(!empty($upgrade_manifest['upgrade_paths'][$previous_version])){
1903 $installdefs = $upgrade_manifest['upgrade_paths'][$previous_version];
1905 $errors[] = 'No Upgrade Path Found in manifest.';
1906 $this->abort($errors);
1911 $this->id_name = $installdefs['id'];
1912 $this->installdefs = $installdefs;
1913 $installed_modules = array();
1914 if(isset($installdefs['beans'])){
1915 foreach($this->installdefs['beans'] as $bean){
1916 $installed_modules[] = $bean['module'];
1921 update_progress_bar('install', $current_step, $total_steps);
1924 foreach($tasks as $task){
1928 update_progress_bar('install', $current_step, $total_steps);
1934 update_progress_bar('install', $current_step, $total_steps);
1937 UpdateSystemTabs('Add',$installed_modules);
1938 $GLOBALS['log']->debug('Complete');
1941 die("No \$installdefs Defined In $this->base_dir/manifest.php");
1945 function disable($base_dir){
1946 global $app_strings;
1947 $total_steps = 3; //min steps with no tasks
1949 $this->base_dir = $base_dir;
1953 'disable_relationships',
1954 'disable_extensions',
1955 'disable_manifest_logichooks',
1958 $total_steps += count($tasks); //now the real number of steps
1959 if(file_exists($this->base_dir . '/manifest.php')){
1962 display_progress_bar('install', $current_step, $total_steps);
1963 echo '<div id ="displayLoglink" ><a href="#" onclick="toggleDisplay(\'displayLog\')">'.$app_strings['LBL_DISPLAY_LOG'].'</a> </div><div id="displayLog" style="display:none">';
1966 require_once($this->base_dir . '/manifest.php');
1967 $this->installdefs = $installdefs;
1968 $this->id_name = $this->installdefs['id'];
1969 $installed_modules = array();
1970 if(isset($this->installdefs['beans'])){
1971 foreach($this->installdefs['beans'] as $bean){
1972 $installed_modules[] = $bean['module'];
1977 update_progress_bar('install', $current_step, $total_steps);
1979 foreach($tasks as $task){
1983 update_progress_bar('install', $current_step, $total_steps);
1988 update_progress_bar('install', $current_step, $total_steps);
1991 UpdateSystemTabs('Restore',$installed_modules);
1994 die("No manifest.php Defined In $this->base_dir/manifest.php");
1998 function enable_vardef($to_module)
2000 $this->enableExt("vardefs", "Vardefs", $to_module);
2003 function enable_layoutdef($to_module)
2005 $this->enableExt("layoutdefs", "Layoutdefs", $to_module);
2008 function enable_relationships(){
2009 if(isset($this->installdefs['relationships'])){
2010 $str = "<?php \n //WARNING: The contents of this file are auto-generated\n";
2011 $save_table_dictionary = false;
2012 foreach($this->installdefs['relationships'] as $relationship){
2013 $filename =basename($relationship['meta_data']);
2015 $save_table_dictionary = true;
2016 $str .= "include_once('metadata/$filename');\n";
2017 if (empty($relationship['module']))
2020 if(!empty($relationship['module_vardefs'])){
2021 $this->enable_vardef($relationship['module']);
2023 if(!empty($relationship['module_layoutdefs'])){
2024 $this->enable_layoutdef($relationship['module']);
2027 $this->rebuild_vardefs();
2028 $this->rebuild_layoutdefs();
2029 if($save_table_dictionary){
2030 if(!file_exists("custom/Extension/application/Ext/TableDictionary")){
2031 mkdir_recursive("custom/Extension/application/Ext/TableDictionary", true);
2033 if (file_exists("custom/Extension/application/Ext/TableDictionary/".DISABLED_PATH."/$this->id_name.php"))
2034 rename("custom/Extension/application/Ext/TableDictionary/".DISABLED_PATH."/$this->id_name.php", "custom/Extension/application/Ext/TableDictionary/$this->id_name.php");
2035 $this->rebuild_tabledictionary();
2040 function disable_relationships($action = 'disable'){
2041 if(isset($this->installdefs['relationships'])){
2042 foreach($this->installdefs['relationships'] as $relationship){
2043 $filename = basename($relationship['meta_data']);
2044 $relName = substr($filename, -12) == "MetaData.php" ? substr($filename,0,strlen($filename) - 12) : "";
2045 if (empty($relationship['module']) && empty($relName))
2048 //remove the vardefs
2049 if (empty($relName))
2050 $path = 'custom/Extension/modules/' . $relationship['module']. '/Ext/Vardefs';
2051 if(!empty($relationship['module']) && $relationship['module'] == 'application'){
2052 $path ='custom/Extension/' . $relationship['module']. '/Ext/Vardefs';
2054 if(!empty($relationship['module_vardefs']) && file_exists($path . '/'. $this->id_name . '.php')){
2055 mkdir_recursive($path . '/'.DISABLED_PATH, true);
2056 rename( $path . '/'. $this->id_name . '.php', $path . '/'.DISABLED_PATH.'/'. $this->id_name . '.php');
2058 //remove the layoutdefs
2059 if ( !empty($relationship['module']) ) {
2060 $path = 'custom/Extension/modules/' . $relationship['module']. '/Ext/Layoutdefs';
2061 if($relationship['module'] == 'application'){
2062 $path ='custom/Extension/' . $relationship['module']. '/Ext/Layoutdefs';
2066 if(!empty($relationship['module_layoutdefs']) && file_exists($path . '/'. $this->id_name . '.php')){
2067 mkdir_recursive($path . '/'.DISABLED_PATH, true);
2068 rename( $path . '/'. $this->id_name . '.php', $path . '/'.DISABLED_PATH.'/'. $this->id_name . '.php');
2072 if(file_exists("custom/Extension/application/Ext/TableDictionary/$this->id_name.php")){
2073 mkdir_recursive("custom/Extension/application/Ext/TableDictionary/".DISABLED_PATH, true);
2074 rename("custom/Extension/application/Ext/TableDictionary/$this->id_name.php", "custom/Extension/application/Ext/TableDictionary/".DISABLED_PATH."/$this->id_name.php");
2076 $this->rebuild_tabledictionary();
2077 $this->rebuild_vardefs();
2078 $this->rebuild_layoutdefs();
2082 function enable_dashlets(){
2083 if(isset($this->installdefs['dashlets'])){
2084 foreach($this->installdefs['dashlets'] as $cp){
2085 $cp['from'] = str_replace('<basepath>', $this->base_dir, $cp['from']);
2086 $path = 'custom/modules/Home/Dashlets/' . $cp['name'] . '/';
2087 $disabled_path = 'custom/modules/Home/'.DISABLED_PATH.'Dashlets/' . $cp['name'];
2088 $GLOBALS['log']->debug("Enabling Dashlet " . $cp['name'] . "..." . $cp['from'] );
2089 if (file_exists($disabled_path))
2091 rename($disabled_path, $path);
2094 include('modules/Administration/RebuildDashlets.php');
2099 function disable_dashlets(){
2100 if(isset($this->installdefs['dashlets'])){
2101 foreach($this->installdefs['dashlets'] as $cp){
2102 $path = 'custom/modules/Home/Dashlets/' . $cp['name'];
2103 $disabled_path = 'custom/modules/Home/'.DISABLED_PATH.'Dashlets/' . $cp['name'];
2104 $GLOBALS['log']->debug('Disabling ' .$path);
2105 if (file_exists($path))
2107 mkdir_recursive('custom/modules/Home/'.DISABLED_PATH.'Dashlets/', true);
2108 rename( $path, $disabled_path);
2111 include('modules/Administration/RebuildDashlets.php');
2115 function enable_copy(){
2116 //copy files back onto file system. first perform md5 check to determine if anything has been modified
2117 //here we should just go through the files in the -restore directory and copy those back
2118 if(isset($GLOBALS['mi_overwrite_files']) && $GLOBALS['mi_overwrite_files']){
2119 if(!empty($this->installdefs['copy'])){
2120 foreach($this->installdefs['copy'] as $cp){
2121 $cp['to'] = clean_path(str_replace('<basepath>', $this->base_dir, $cp['to']));
2122 $backup_path = clean_path( remove_file_extension(urldecode(hashToFile($_REQUEST['install_file'])))."-restore/".$cp['to'] );
2124 //check if this file exists in the -restore directory
2125 if(file_exists($backup_path)){
2126 //since the file exists, then we want do an md5 of the install version and the file system version
2127 //if(is_file($backup_path) && md5_file($backup_path) == md5_file($cp['to'])){
2128 //since the files are the same then we can safely move back from the -restore
2129 //directory into the file system
2130 $GLOBALS['log']->debug("ENABLE COPY:: FROM: ".$cp['from']. " TO: ".$cp['to']);
2131 $this->copy_path($cp['from'], $cp['to']);
2133 //since they are not equal then we need to prompt the user
2141 function disable_copy(){
2142 //when we disable we want to copy the -restore files back into the file system
2143 //but we should check the version in the module install against the version on the file system
2144 //if they match then we can copy the file back, but otherwise we should ask the user.
2146 // $GLOBALS['log']->debug('ModuleInstaller.php->disable_copy()');
2147 if(isset($GLOBALS['mi_overwrite_files']) && $GLOBALS['mi_overwrite_files']){
2148 // $GLOBALS['log']->debug('ModuleInstaller.php->disable_copy():mi_overwrite_files=true');
2149 if(!empty($this->installdefs['copy'])){
2150 // $GLOBALS['log']->debug('ModuleInstaller.php->disable_copy(): installdefs not empty');
2151 foreach($this->installdefs['copy'] as $cp){
2152 $cp['to'] = clean_path(str_replace('<basepath>', $this->base_dir, $cp['to']));
2153 $backup_path = clean_path( remove_file_extension(urldecode(hashToFile($_REQUEST['install_file'])))."-restore/".$cp['to'] ); // bug 16966 tyoung - replaced missing assignment to $backup_path
2154 //check if this file exists in the -restore directory
2155 // $GLOBALS['log']->debug("ModuleInstaller.php->disable_copy(): backup_path=".$backup_path);
2156 if(file_exists($backup_path)){
2157 //since the file exists, then we want do an md5 of the install version and the file system version
2158 $from = str_replace('<basepath>', $this->base_dir, $cp['from']);
2160 //if(is_file($from) && md5_file($from) == md5_file($cp['to'])){
2161 //since the files are the same then we can safely move back from the -restore
2162 //directory into the file system
2163 $GLOBALS['log']->debug("DISABLE COPY:: FROM: ".$backup_path. " TO: ".$cp['to']);
2164 $this->copy_path($backup_path, $cp['to']);
2166 //since they are not equal then we need to prompt the user
2174 public function reset_opcodes()
2176 /* Bug 39354 - added function_exists check. Not optimal fix, but safe nonetheless.
2177 * This is for the upgrade to 6.1 from pre 6.1, since the utils files haven't been updated to 6.1 when this is called,
2178 * but this file has been updated to 6.1
2180 if(function_exists('sugar_clean_opcodes')){
2181 sugar_clean_opcodes();
2186 * BC implementation to provide specific calls to extensions
2188 public function __call($name, $args)
2190 $nameparts = explode('_', $name);
2191 // name is something_something
2192 if(count($nameparts) == 2 && isset($this->extensions[$nameparts[1]])) {
2193 $ext = $this->extensions[$nameparts[1]];
2194 switch($nameparts[0]) {
2196 return $this->enableExt($ext['section'], $ext['extdir']);
2198 return $this->disableExt($ext['section'], $ext['extdir']);
2200 return $this->installExt($ext['section'], $ext['extdir']);
2202 return $this->uninstallExt($ext['section'], $ext['extdir']);
2204 return $this->rebuildExt($ext['extdir'], $ext['file']);
2207 sugar_die("Unknown method ModuleInstaller::$name called");
2212 function UpdateSystemTabs($action, $installed_modules){
2213 require_once("modules/MySettings/TabController.php");
2214 $controller = new TabController();
2215 $isSystemTabsInDB = $controller->is_system_tabs_in_db();
2216 if ($isSystemTabsInDB && !empty($installed_modules))
2222 $currentTabs = $controller->get_system_tabs();
2223 foreach ($installed_modules as $module)
2225 if(in_array($module, $currentTabs)){
2226 unset($currentTabs[$module]);
2229 $controller->set_system_tabs($currentTabs);;
2232 $currentTabs = $controller->get_system_tabs();
2233 foreach ($installed_modules as $module)
2235 if(!in_array($module, $currentTabs)){
2236 $currentTabs[$module] = $module;
2239 $controller->set_system_tabs($currentTabs);