forked from bkilgore/sugarcrm_dev
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathModuleInstaller.php
More file actions
2346 lines (2129 loc) · 90.5 KB
/
Copy pathModuleInstaller.php
File metadata and controls
2346 lines (2129 loc) · 90.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
/*********************************************************************************
* SugarCRM is a customer relationship management program developed by
* SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
*
* This program is free software; you can redistribute it and/or modify it under
* the terms of the GNU Affero General Public License version 3 as published by the
* Free Software Foundation with the addition of the following permission added
* to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
* IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
* OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
* details.
*
* You should have received a copy of the GNU Affero General Public License along with
* this program; if not, see http://www.gnu.org/licenses or write to the Free
* Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301 USA.
*
* You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
* SW2-130, Cupertino, CA 95014, USA. or at email address [email protected].
*
* The interactive user interfaces in modified source and object code versions
* of this program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU Affero General Public License version 3.
*
* In accordance with Section 7(b) of the GNU Affero General Public License version 3,
* these Appropriate Legal Notices must retain the display of the "Powered by
* SugarCRM" logo. If the display of the logo is not reasonably feasible for
* technical reasons, the Appropriate Legal Notices must display the words
* "Powered by SugarCRM".
********************************************************************************/
/*
* ModuleInstaller - takes an installation package from files in the custom/Extension/X directories, and moves them into custom/X to install them.
* If a directory has multiple files they are concatenated together.
* Relevant directories (X) are Layoutdefs, Vardefs, Include (bean stuff), Language, TableDictionary (relationships)
*
* Installation steps that involve more than just copying files:
* 1. installing custom fields - calls bean->custom_fields->addField
* 2. installing relationships - calls createTableParams to build the relationship table, and createRelationshipMeta to add the relationship to the relationship table
* 3. rebuilding the relationships - at almost the last step in install(), calls modules/Administration/RebuildRelationship.php
* 4. repair indices - uses "modules/Administration/RepairIndex.php";
*/
require_once('include/utils/progress_bar_utils.php');
require_once('ModuleInstall/ModuleScanner.php');
define('DISABLED_PATH', 'Disabled');
class ModuleInstaller{
var $modules = array();
var $silent = false;
var $base_dir = '';
var $modulesInPackage = array();
function ModuleInstaller(){
$this->ms = new ModuleScanner();
$this->modules = get_module_dir_list();
$this->db = & DBManagerFactory::getInstance();
}
/*
* 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
* 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
* and moduleList - and then calls ModuleInstaller->merge_files('Ext/Include', 'modules.ext.php', '', true) to merge the individual module files into a combined file
* /custom/Extension/application/Ext/Include/modules.ext.php (which now contains a list of all $beanList, $beanFiles and $moduleList for all extension modules) -
* this file modules.ext.php is included at the end of modules.php.
*
* 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.
*/
function install($base_dir, $is_upgrade = false, $previous_version = ''){
if(defined('TEMPLATE_URL'))SugarTemplateUtilities::disableCache();
if(!empty($GLOBALS['sugar_config']['moduleInstaller']['packageScan'])){
$this->ms->scanPackage($base_dir);
if($this->ms->hasIssues()){
$this->ms->displayIssues();
sugar_cleanup(true);
}
}
global $app_strings, $mod_strings;
$this->base_dir = $base_dir;
$total_steps = 5; //minimum number of steps with no tasks
$current_step = 0;
$tasks = array(
'pre_execute',
'install_copy',
'install_images',
'install_menus',
'install_dcactions',
'install_userpage',
'install_dashlets',
'install_administration',
'install_connectors',
'install_vardefs',
'install_layoutdefs',
'install_layoutfields',
'install_relationships',
'install_languages',
'install_logichooks',
'post_execute',
'reset_opcodes',
);
$total_steps += count($tasks);
if(file_exists($this->base_dir . '/manifest.php')){
if(!$this->silent){
$current_step++;
display_progress_bar('install', $current_step, $total_steps);
echo '<div id ="displayLoglink" ><a href="#" onclick="document.getElementById(\'displayLog\').style.display=\'\'">'
.$app_strings['LBL_DISPLAY_LOG'].'</a> </div><div id="displayLog" style="display:none">';
}
include($this->base_dir . '/manifest.php');
if($is_upgrade && !empty($previous_version)){
//check if the upgrade path exists
if(!empty($upgrade_manifest)){
if(!empty($upgrade_manifest['upgrade_paths'])){
if(!empty($upgrade_manifest['upgrade_paths'][$previous_version])){
$installdefs = $upgrade_manifest['upgrade_paths'][$previous_version];
}else{
$errors[] = 'No Upgrade Path Found in manifest.';
$this->abort($errors);
}//fi
}//fi
}//fi
}//fi
$this->id_name = $installdefs['id'];
$this->installdefs = $installdefs;
$installed_modules = array();
$tab_modules = array();
if(isset($installdefs['beans'])){
$str = "<?php \n //WARNING: The contents of this file are auto-generated\n";
foreach($installdefs['beans'] as $bean){
if(!empty($bean['module']) && !empty($bean['class']) && !empty($bean['path'])){
$module = $bean['module'];
$class = $bean['class'];
$path = $bean['path'];
$str .= "\$beanList['$module'] = '$class';\n";
$str .= "\$beanFiles['$class'] = '$path';\n";
if($bean['tab']){
$str .= "\$moduleList[] = '$module';\n";
$this->install_user_prefs($module, empty($bean['hide_by_default']));
$tab_modules[] = $module;
}else{
$str .= "\$modules_exempt_from_availability_check['$module'] = '$module';\n";
$str .= "\$modInvisList[] = '$module';\n";
}
$installed_modules[] = $module;
}else{
$errors[] = 'Bean array not well defined.';
$this->abort($errors);
}
}
$str.= "\n?>";
if(!file_exists("custom/Extension/application/Ext/Include")){
mkdir_recursive("custom/Extension/application/Ext/Include", true);
}
$out = sugar_fopen("custom/Extension/application/Ext/Include/$this->id_name.php", 'w');
fwrite($out,$str);
fclose($out);
$this->rebuild_modules();
}
if(!$this->silent){
$current_step++;
update_progress_bar('install', $current_step, $total_steps);
}
foreach($tasks as $task){
$this->$task();
if(!$this->silent){
$current_step++;
update_progress_bar('install', $current_step, $total_steps);
}
}
$this->install_beans($installed_modules);
if(!$this->silent){
$current_step++;
update_progress_bar('install', $total_steps, $total_steps);
}
if(isset($installdefs['custom_fields'])){
$this->log(translate('LBL_MI_IN_CUSTOMFIELD'));
$this->install_custom_fields($installdefs['custom_fields']);
}
if(!$this->silent){
$current_step++;
update_progress_bar('install', $current_step, $total_steps);
echo '</div>';
}
if(!$this->silent){
$current_step++;
update_progress_bar('install', $current_step, $total_steps);
echo '</div>';
}
$selectedActions = array(
'clearTpls',
'clearJsFiles',
'clearDashlets',
'clearVardefs',
'clearJsLangFiles',
'rebuildAuditTables',
'repairDatabase',
);
VardefManager::clearVardef();
global $beanList, $beanFiles, $moduleList;
if (file_exists('custom/application/Ext/Include/modules.ext.php'))
{
include('custom/application/Ext/Include/modules.ext.php');
}
require_once("modules/Administration/upgrade_custom_relationships.php");
upgrade_custom_relationships($installed_modules);
$this->rebuild_all(true);
require_once('modules/Administration/QuickRepairAndRebuild.php');
$rac = new RepairAndClear();
$rac->repairAndClearAll($selectedActions, $installed_modules,true, false);
$this->rebuild_relationships();
$this->log('<br><b>' . translate('LBL_MI_COMPLETE') . '</b>');
UpdateSystemTabs('Add',$tab_modules);
}else{
die("No \$installdefs Defined In $this->base_dir/manifest.php");
}
}
function install_user_prefs($module, $hide_from_user=false){
UserPreference::updateAllUserPrefs('display_tabs', $module, '', true, !$hide_from_user);
UserPreference::updateAllUserPrefs('hide_tabs', $module, '', true, $hide_from_user);
UserPreference::updateAllUserPrefs('remove_tabs', $module, '', true, $hide_from_user);
}
function uninstall_user_prefs($module){
UserPreference::updateAllUserPrefs('display_tabs', $module, '', true, true);
UserPreference::updateAllUserPrefs('hide_tabs', $module, '', true, true);
UserPreference::updateAllUserPrefs('remove_tabs', $module, '', true, true);
}
function pre_execute(){
require_once($this->base_dir . '/manifest.php');
if(isset($this->installdefs['pre_execute']) && is_array($this->installdefs['pre_execute'])){
foreach($this->installdefs['pre_execute'] as $includefile){
require_once(str_replace('<basepath>', $this->base_dir, $includefile));
}
}
}
function post_execute(){
require_once($this->base_dir . '/manifest.php');
if(isset($this->installdefs['post_execute']) && is_array($this->installdefs['post_execute'])){
foreach($this->installdefs['post_execute'] as $includefile){
require_once(str_replace('<basepath>', $this->base_dir, $includefile));
}
}
}
function pre_uninstall(){
require_once($this->base_dir . '/manifest.php');
if(isset($this->installdefs['pre_uninstall']) && is_array($this->installdefs['pre_uninstall'])){
foreach($this->installdefs['pre_uninstall'] as $includefile){
require_once(str_replace('<basepath>', $this->base_dir, $includefile));
}
}
}
function post_uninstall(){
require_once($this->base_dir . '/manifest.php');
if(isset($this->installdefs['post_uninstall']) && is_array($this->installdefs['post_uninstall'])){
foreach($this->installdefs['post_uninstall'] as $includefile){
require_once(str_replace('<basepath>', $this->base_dir, $includefile));
}
}
}
/*
* 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
* (specified as from and to in the manifest), replacing <basepath> by the base_dir value passed in to install.
*/
function install_copy(){
if(isset($this->installdefs['copy'])){
/* BEGIN - RESTORE POINT - by MR. MILK August 31, 2005 02:22:11 PM */
$backup_path = clean_path( remove_file_extension(urldecode(hashToFile($_REQUEST['install_file'])))."-restore" );
/* END - RESTORE POINT - by MR. MILK August 31, 2005 02:22:18 PM */
foreach($this->installdefs['copy'] as $cp){
$GLOBALS['log']->debug("Copying ..." . $cp['from']. " to " .$cp['to'] );
/* BEGIN - RESTORE POINT - by MR. MILK August 31, 2005 02:22:11 PM */
//$this->copy_path($cp['from'], $cp['to']);
$this->copy_path($cp['from'], $cp['to'], $backup_path);
/* END - RESTORE POINT - by MR. MILK August 31, 2005 02:22:18 PM */
}
//here we should get the module list again as we could have copied something to the modules dir
$this->modules = get_module_dir_list();
}
}
function uninstall_copy(){
if(!empty($this->installdefs['copy'])){
foreach($this->installdefs['copy'] as $cp){
$cp['to'] = clean_path(str_replace('<basepath>', $this->base_dir, $cp['to']));
$cp['from'] = clean_path(str_replace('<basepath>', $this->base_dir, $cp['from']));
$GLOBALS['log']->debug('Unlink ' . $cp['to']);
/* BEGIN - RESTORE POINT - by MR. MILK August 31, 2005 02:22:11 PM */
//rmdir_recursive($cp['to']);
$backup_path = clean_path( remove_file_extension(urldecode(hashToFile($_REQUEST['install_file'])))."-restore/".$cp['to'] );
$this->uninstall_new_files($cp, $backup_path);
$this->copy_path($backup_path, $cp['to'], $backup_path, true);
/* END - RESTORE POINT - by MR. MILK August 31, 2005 02:22:18 PM */
}
$backup_path = clean_path( remove_file_extension(urldecode(hashToFile($_REQUEST['install_file'])))."-restore");
if(file_exists($backup_path))
rmdir_recursive($backup_path);
}
}
/**
* Removes any files that were added by the loaded module. If the files already existed prior to install
* it will be handled by copy_path with the uninstall parameter.
*
*/
function uninstall_new_files($cp, $backup_path){
$zip_files = $this->dir_get_files($cp['from'],$cp['from']);
$backup_files = $this->dir_get_files($backup_path, $backup_path);
foreach($zip_files as $k=>$v){
//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
if(!isset($backup_files[$k])){
$to = $cp['to'] . $k;
//if it's not a sugar file then we remove it otherwise we can't restor it
if(!$this->ms->sugarFileExists($to)){
$GLOBALS['log']->debug('ModuleInstaller[uninstall_new_file] deleting file ' . $to);
unlink($to);
}else{
$GLOBALS['log']->fatal('ModuleInstaller[uninstall_new_file] Could not remove file ' . $to . ' as no backup file was found to restore to');
}
}
}
//lets check if the directory is empty if it is we will delete it as well
$files_remaining = $this->dir_file_count($cp['to']);
if(file_exists($cp['to']) && $files_remaining == 0){
$GLOBALS['log']->debug('ModuleInstaller[uninstall_new_file] deleting directory ' . $cp['to']);
rmdir_recursive($cp['to']);
}
}
function install_dashlets(){
if(isset($this->installdefs['dashlets'])){
foreach($this->installdefs['dashlets'] as $cp){
$this->log(translate('LBL_MI_IN_DASHLETS') . $cp['name']);
$cp['from'] = str_replace('<basepath>', $this->base_dir, $cp['from']);
$path = 'custom/modules/Home/Dashlets/' . $cp['name'] . '/';
$GLOBALS['log']->debug("Installing Dashlet " . $cp['name'] . "..." . $cp['from'] );
if(!file_exists($path)){
mkdir_recursive($path, true);
}
copy_recursive($cp['from'] , $path);
}
include('modules/Administration/RebuildDashlets.php');
}
}
function uninstall_dashlets(){
if(isset($this->installdefs['dashlets'])){
foreach($this->installdefs['dashlets'] as $cp){
$this->log(translate('LBL_MI_UN_DASHLETS') . $cp['name']);
$path = 'custom/modules/Home/Dashlets/' . $cp['name'];
$GLOBALS['log']->debug('Unlink ' .$path);
if (file_exists($path))
rmdir_recursive($path);
}
include('modules/Administration/RebuildDashlets.php');
}
}
function install_images(){
if(isset($this->installdefs['image_dir'])){
$this->log( translate('LBL_MI_IN_IMAGES') );
$this->copy_path($this->installdefs['image_dir'] , 'custom/themes');
}
}
function install_menus(){
if(isset($this->installdefs['menu'])){
$this->log(translate('LBL_MI_IN_MENUS'));
foreach($this->installdefs['menu'] as $menu){
$menu['from'] = str_replace('<basepath>', $this->base_dir, $menu['from']);
$GLOBALS['log']->debug("Installing Menu ..." . $menu['from']. " for " .$menu['to_module'] );
$path = 'custom/Extension/modules/' . $menu['to_module']. '/Ext/Menus';
if($menu['to_module'] == 'application'){
$path ='custom/Extension/' . $menu['to_module']. '/Ext/Menus';
}
if(!file_exists($path)){
mkdir_recursive($path, true);
}
copy_recursive($menu['from'] , $path . '/'. $this->id_name . '.php');
}
$this->rebuild_menus();
}
}
function uninstall_menus(){
if(isset($this->installdefs['menu'])){
$this->log(translate('LBL_MI_UN_MENUS'));
foreach($this->installdefs['menu'] as $menu){
$menu['from'] = str_replace('<basepath>', $this->base_dir, $menu['from']);
$GLOBALS['log']->debug("Uninstalling Menu ..." . $menu['from']. " for " .$menu['to_module'] );
$path = 'custom/Extension/modules/' . $menu['to_module']. '/Ext/Menus';
if($menu['to_module'] == 'application'){
$path ='custom/Extension/' . $menu['to_module']. '/Ext/Menus';
}
if (sugar_is_file($path . '/'. $this->id_name . '.php', 'w'))
{
rmdir_recursive( $path . '/'. $this->id_name . '.php');
}
else if (sugar_is_file($path . '/'. DISABLED_PATH . '/'. $this->id_name . '.php', 'w'))
{
rmdir_recursive( $path . '/'. DISABLED_PATH . '/'. $this->id_name . '.php');
}
}
$this->rebuild_menus();
}
}
function install_dcactions(){
if(isset($this->installdefs['dcaction'])){
$this->log(translate('LBL_MI_IN_MENUS'));
foreach($this->installdefs['dcaction'] as $action){
$action['from'] = str_replace('<basepath>', $this->base_dir, $action['from']);
$GLOBALS['log']->debug("Installing DCActions ..." . $action['from']);
$path = 'custom/Extension/application/Ext/DashletContainer/Containers';
if(!file_exists($path)){
mkdir_recursive($path, true);
}
copy_recursive($action['from'] , $path . '/'. $this->id_name . '.php');
}
$this->rebuild_dashletcontainers();
}
}
function uninstall_dcactions(){
if(isset($this->installdefs['dcaction'])){
$this->log(translate('LBL_MI_UN_MENUS'));
foreach($this->installdefs['dcaction'] as $action){
$action['from'] = str_replace('<basepath>', $this->base_dir, $action['from']);
$GLOBALS['log']->debug("Uninstalling DCActions ..." . $action['from'] );
$path = 'custom/Extension/application/Ext/DashletContainer/Containers';
if (sugar_is_file($path . '/'. $this->id_name . '.php', 'w'))
{
rmdir_recursive( $path . '/'. $this->id_name . '.php');
}
else if (sugar_is_file($path . '/'. DISABLED_PATH . '/'. $this->id_name . '.php', 'w'))
{
rmdir_recursive( $path . '/'. DISABLED_PATH . '/'. $this->id_name . '.php');
}
}
$this->rebuild_dashletcontainers();
}
}
function install_administration(){
if(isset($this->installdefs['administration'])){
$this->log(translate('LBL_MI_IN_ADMIN'));
foreach($this->installdefs['administration'] as $administration){
$administration['from'] = str_replace('<basepath>', $this->base_dir, $administration['from']);
$GLOBALS['log']->debug("Installing Administration Section ..." . $administration['from'] );
$path = 'custom/Extension/modules/Administration/Ext/Administration';
if(!file_exists($path)){
mkdir_recursive($path, true);
}
copy_recursive($administration['from'] , $path . '/'. $this->id_name . '.php');
}
$this->rebuild_administration();
}
}
function uninstall_administration(){
if(isset($this->installdefs['administration'])){
$this->log(translate('LBL_MI_UN_ADMIN'));
foreach($this->installdefs['administration'] as $administration){
$administration['from'] = str_replace('<basepath>', $this->base_dir, $administration['from']);
$GLOBALS['log']->debug("Uninstalling Administration Section ..." . $administration['from'] );
$path = 'custom/Extension/modules/Administration/Ext/Administration';
if (sugar_is_file($path . '/'. $this->id_name . '.php', "w"))
rmdir_recursive( $path . '/'. $this->id_name . '.php');
else if (sugar_is_file($path . '/'. DISABLED_PATH . "/" . $this->id_name . '.php', "w"))
rmdir_recursive( $path . '/'. DISABLED_PATH . "/" . $this->id_name . '.php');
}
$this->rebuild_administration();
}
}
function install_connectors(){
if(isset($this->installdefs['connectors'])){
foreach($this->installdefs['connectors'] as $cp){
$this->log(translate('LBL_MI_IN_CONNECTORS') . $cp['name']);
$dir = str_replace('_','/',$cp['name']);
$cp['connector'] = str_replace('<basepath>', $this->base_dir, $cp['connector']);
$source_path = 'custom/modules/Connectors/connectors/sources/' . $dir. '/';
$GLOBALS['log']->debug("Installing Connector " . $cp['name'] . "..." . $cp['connector'] );
if(!file_exists($source_path)){
mkdir_recursive($source_path, true);
}
copy_recursive($cp['connector'] , $source_path);
//Install optional formatter code if it is specified
if(!empty($cp['formatter'])) {
$cp['formatter'] = str_replace('<basepath>', $this->base_dir, $cp['formatter']);
$formatter_path = 'custom/modules/Connectors/connectors/formatters/' . $dir. '/';
if(!file_exists($formatter_path)){
mkdir_recursive($formatter_path, true);
}
copy_recursive($cp['formatter'] , $formatter_path);
}
}
require_once('include/connectors/utils/ConnectorUtils.php');
ConnectorUtils::installSource($cp['name']);
}
}
function uninstall_connectors(){
if(isset($this->installdefs['connectors'])){
foreach($this->installdefs['connectors'] as $cp){
$this->log(translate('LBL_MI_UN_CONNECTORS') . $cp['name']);
$dir = str_replace('_','/',$cp['name']);
$source_path = 'custom/modules/Connectors/connectors/sources/' . $dir;
$formatter_path = 'custom/modules/Connectors/connectors/formatters/' . $dir;
$GLOBALS['log']->debug('Unlink ' .$source_path);
rmdir_recursive($source_path);
rmdir_recursive($formatter_path);
}
require_once('include/connectors/utils/ConnectorUtils.php');
//ConnectorUtils::getConnectors(true);
ConnectorUtils::uninstallSource($cp['name']);
}
}
function install_userpage(){
if(isset($this->installdefs['user_page'])){
$this->log(translate('LBL_MI_IN_USER'));
foreach($this->installdefs['user_page'] as $userpage){
$userpage['from'] = str_replace('<basepath>', $this->base_dir, $userpage['from']);
$GLOBALS['log']->debug("Installing User Page Section ..." . $userpage['from'] );
$path = 'custom/Extension/modules/Users/Ext/UserPage';
if(!file_exists($path)){
mkdir_recursive($path, true);
}
copy_recursive($userpage['from'] , $path . '/'. $this->id_name . '.php');
}
$this->rebuild_userpage();
}
}
function uninstall_userpage(){
if(isset($this->installdefs['user_page'])){
$this->log(translate('LBL_MI_UN_USER') );
foreach($this->installdefs['user_page'] as $userpage){
$userpage['from'] = str_replace('<basepath>', $this->base_dir, $userpage['from']);
$GLOBALS['log']->debug("Uninstalling User Page Section ..." . $userpage['from'] );
$path = 'custom/Extension/modules/Users/Ext/UserPage';
rmdir_recursive( $path . '/'. $this->id_name . '.php');
}
$this->rebuild_userpage();
}
}
/*
* ModuleInstaller->install_vardefs uses the vardefs section of the installdefs and copies from the 'from' path (replacing <basepath> as usual) to either
* custom/Extension/modules/<module>/Ext/Vardefs or custom/Extension/<module>/Ext/Vardefs if the 'to_module' value in the installdefs is set to 'application'.
* Finally rebuild_vardefs() is used to merge /Ext/Vardefs into vardefs.ext.php
*/
function install_vardefs(){
if(isset($this->installdefs['vardefs'])){
$this->log(translate('LBL_MI_IN_VAR') );
foreach($this->installdefs['vardefs'] as $vardefs){
$vardefs['from'] = str_replace('<basepath>', $this->base_dir, $vardefs['from']);
$this->install_vardef($vardefs['from'], $vardefs['to_module'], $this->id_name);
}
$this->rebuild_vardefs();
}
}
function uninstall_vardefs(){
if(isset($this->installdefs['vardefs'])){
$this->log(translate('LBL_MI_UN_VAR') );
foreach($this->installdefs['vardefs'] as $vardefs){
$vardefs['from'] = str_replace('<basepath>', $this->base_dir, $vardefs['from']);
$GLOBALS['log']->debug("Uninstalling Vardefs ..." . $vardefs['from'] . " for " .$vardefs['to_module']);
$path = 'custom/Extension/modules/' . $vardefs['to_module']. '/Ext/Vardefs';
if($vardefs['to_module'] == 'application'){
$path ='custom/Extension/' . $vardefs['to_module']. '/Ext/Vardefs';
}
if(file_exists($path . '/'. $this->id_name . '.php'))
{
rmdir_recursive( $path . '/'. $this->id_name . '.php');
}
else if(file_exists($path . '/'. DISABLED_PATH . '/'. $this->id_name . '.php'))
{
rmdir_recursive($path . '/'. DISABLED_PATH . '/'. $this->id_name . '.php');
}
else if (file_exists($path . '/'. basename($vardefs['from'] )))
{
rmdir_recursive( $path . '/'. basename($vardefs['from'] ));
}
else if(file_exists($path . '/'. DISABLED_PATH . '/'. basename($vardefs['from'])))
{
rmdir_recursive($path . '/'. DISABLED_PATH . '/'. basename($vardefs['from']));
}
}
$this->rebuild_vardefs();
}
}
function install_vardef($from, $to_module){
$GLOBALS['log']->debug("Installing Vardefs ..." . $from . " for " .$to_module);
$path = 'custom/Extension/modules/' . $to_module. '/Ext/Vardefs';
if($to_module == 'application'){
$path ='custom/Extension/' . $to_module. '/Ext/Vardefs';
}
if(!file_exists($path)){
mkdir_recursive($path, true);
}
copy_recursive($from , $path.'/'. basename($from));
}
/*
* ModuleInstaller->install_layoutdefs installs the $layout_defs variable (subpanel definitions) from Ext/Layoutdefs to the to_module location of
* custom/Extension/modules/' . $to_module. '/Ext/Layoutdefs/<$module>.php. before calling rebuild_layoutdefs which merge_files Ext/Layoutdefs/, 'layoutdefs.ext.php'. Note that this is not used for the viewdefs in the metadata directory - they are installed through the install_copy() operation that just takes the contents of the module directory and places it in the /modules area.
*/
function install_layoutdefs(){
if(isset($this->installdefs['layoutdefs'])){
$this->log(translate('LBL_MI_IN_SUBPANEL') );
foreach($this->installdefs['layoutdefs'] as $layoutdefs){
$layoutdefs['from'] = str_replace('<basepath>', $this->base_dir, $layoutdefs['from']);
$this->install_layoutdef($layoutdefs['from'], $layoutdefs['to_module'], $this->id_name);
}
$this->rebuild_layoutdefs();
}
}
function uninstall_layoutdefs(){
if(isset($this->installdefs['layoutdefs'])){
$this->log(translate('LBL_MI_UN_SUBPANEL') );
foreach($this->installdefs['layoutdefs'] as $layoutdefs){
$layoutdefs['from'] = str_replace('<basepath>', $this->base_dir, $layoutdefs['from']);
$GLOBALS['log']->debug("Uninstalling Layoutdefs ..." . $layoutdefs['from'] . " for " .$layoutdefs['to_module']);
$path = 'custom/Extension/modules/' . $layoutdefs['to_module']. '/Ext/Layoutdefs';
if($layoutdefs['to_module'] == 'application'){
$path ='custom/Extension/' . $layoutdefs['to_module']. '/Ext/Layoutdefs';
}
if (file_exists($path . '/'. $this->id_name . '.php'))
{
rmdir_recursive( $path . '/'. $this->id_name . '.php');
}
else if (file_exists($path . '/'. DISABLED_PATH . '/' . $this->id_name . '.php'))
{
rmdir_recursive($path . '/'. DISABLED_PATH . '/' . $this->id_name . '.php');
}
else if (file_exists($path . '/'. basename($layoutdefs['from'] )))
{
rmdir_recursive( $path . '/'. basename($layoutdefs['from'] ));
}
else if(file_exists($path . '/'. DISABLED_PATH . '/'. basename($layoutdefs['from'])))
{
rmdir_recursive($path . '/'. DISABLED_PATH . '/'. basename($layoutdefs['from']));
}
}
$this->rebuild_layoutdefs();
}
}
function install_layoutdef($from, $to_module){
$GLOBALS['log']->debug("Installing Layout Defs ..." . $from . " for " .$to_module);
$path = 'custom/Extension/modules/' . $to_module. '/Ext/Layoutdefs';
if($to_module == 'application'){
$path ='custom/Extension/' . $to_module. '/Ext/Layoutdefs';
}
if(!file_exists($path)){
mkdir_recursive($path, true);
}
copy_recursive($from , $path.'/'. basename($from));
}
function install_languages()
{
$languages = array();
if(isset($this->installdefs['language']))
{
$this->log(translate('LBL_MI_IN_LANG') );
foreach($this->installdefs['language'] as $packs)
{
$modules[]=$packs['to_module'];
$languages[$packs['language']] = $packs['language'];
$packs['from'] = str_replace('<basepath>', $this->base_dir, $packs['from']);
$GLOBALS['log']->debug("Installing Language Pack ..." . $packs['from'] . " for " .$packs['to_module']);
$path = 'custom/Extension/modules/' . $packs['to_module']. '/Ext/Language';
if($packs['to_module'] == 'application'){
$path ='custom/Extension/' . $packs['to_module']. '/Ext/Language';
}
if(!file_exists($path)){
mkdir_recursive($path, true);
}
copy_recursive($packs['from'] , $path.'/'.$packs['language'].'.'. $this->id_name . '.php');
}
$this->rebuild_languages($languages, $modules);
}
}
function uninstall_languages(){
$languages = array();
if(isset($this->installdefs['language'])){
$this->log(translate('LBL_MI_UN_LANG') );
foreach($this->installdefs['language'] as $packs){
$modules[]=$packs['to_module'];
$languages[$packs['language']] = $packs['language'];
$packs['from'] = str_replace('<basepath>', $this->base_dir, $packs['from']);
$GLOBALS['log']->debug("Uninstalling Language Pack ..." . $packs['from'] . " for " .$packs['to_module']);
$path = 'custom/Extension/modules/' . $packs['to_module']. '/Ext/Language';
if($packs['to_module'] == 'application'){
$path ='custom/Extension/' . $packs['to_module']. '/Ext/Language';
}
if (sugar_is_file($path.'/'.$packs['language'].'.'. $this->id_name . '.php', 'w')) {
rmdir_recursive( $path.'/'.$packs['language'].'.'. $this->id_name . '.php');
} else if (sugar_is_file($path.'/'.DISABLED_PATH.'/'.$packs['language'].'.'. $this->id_name . '.php', 'w')) {
rmdir_recursive($path.'/'.DISABLED_PATH.'/'.$packs['language'].'.'. $this->id_name . '.php', 'w');
}
}
$this->rebuild_languages($languages, $modules);
}
}
// Functions for adding and removing logic hooks from uploaded files
// 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
/* The module hook definition should look like this:
$installdefs = array(
... blah blah ...
'logic_hooks' => array(
array('module' => 'Accounts',
'hook' => 'after_save',
'order' => 99,
'description' => 'Account sample logic hook',
'file' => 'modules/Sample/sample_account_logic_hook_file.php',
'class' => 'SampleLogicClass',
'function' => 'accountAfterSave',
),
),
... blah blah ...
);
*/
function install_logichooks() {
// Since the logic hook files get copied over with the rest of the module directory, we just need to enable them
$this->enable_logichooks();
}
function uninstall_logichooks() {
// Since the logic hook files get removed with the rest of the module directory, we just need to disable them
$this->disable_logichooks();
}
function enable_logichooks() {
if(empty($this->installdefs['logic_hooks']) || !is_array($this->installdefs['logic_hooks'])) {
return;
}
foreach($this->installdefs['logic_hooks'] as $hook ) {
check_logic_hook_file($hook['module'], $hook['hook'], array($hook['order'], $hook['description'], $hook['file'], $hook['class'], $hook['function']));
}
}
function disable_logichooks() {
if(empty($this->installdefs['logic_hooks']) || !is_array($this->installdefs['logic_hooks'])) {
return;
}
foreach($this->installdefs['logic_hooks'] as $hook ) {
remove_logic_hook($hook['module'], $hook['hook'], array($hook['order'], $hook['description'], $hook['file'], $hook['class'], $hook['function']));
}
}
/* BEGIN - RESTORE POINT - by MR. MILK August 31, 2005 02:22:18 PM */
function copy_path($from, $to, $backup_path='', $uninstall=false){
//function copy_path($from, $to){
/* END - RESTORE POINT - by MR. MILK August 31, 2005 02:22:18 PM */
$to = str_replace('<basepath>', $this->base_dir, $to);
if(!$uninstall) {
$from = str_replace('<basepath>', $this->base_dir, $from);
$GLOBALS['log']->debug('Copy ' . $from);
}
else {
$from = str_replace('<basepath>', $backup_path, $from);
//$GLOBALS['log']->debug('Restore ' . $from);
}
$from = clean_path($from);
$to = clean_path($to);
$dir = dirname($to);
//there are cases where if we need to create a directory in the root directory
if($dir == '.' && is_dir($from)){
$dir = $to;
}
if(!sugar_is_dir($dir, 'instance'))
mkdir_recursive($dir, true);
/* BEGIN - RESTORE POINT - by MR. MILK August 31, 2005 02:22:18 PM */
if(empty($backup_path)) {
/* END - RESTORE POINT - by MR. MILK August 31, 2005 02:22:18 PM */
if(!copy_recursive($from, $to)){
die('Failed to copy ' . $from. ' ' . $to);
}
/* BEGIN - RESTORE POINT - by MR. MILK August 31, 2005 02:22:18 PM */
}
elseif(!$this->copy_recursive_with_backup($from, $to, $backup_path, $uninstall)){
die('Failed to copy ' . $from. ' to ' . $to);
}
/* END - RESTORE POINT - by MR. MILK August 31, 2005 02:22:18 PM */
}
function install_custom_fields($fields){
global $beanList, $beanFiles;
include('include/modules.php');
require_once('modules/DynamicFields/FieldCases.php');
foreach($fields as $field){
$installed = false;
if(isset($beanList[ $field['module']])){
$class = $beanList[ $field['module']];
if(!isset($field['ext4']))$field['ext4'] = '';
if(!isset($field['mass_update']))$field['mass_update'] = 0;
if(!isset($field['duplicate_merge']))$field['duplicate_merge'] = 0;
if(!isset($field['help']))$field['help'] = '';
if(file_exists($beanFiles[$class])){
require_once($beanFiles[$class]);
$mod = new $class();
$installed = true;
$fieldObject = get_widget($field['type']);
$fieldObject->populateFromRow($field);
$mod->custom_fields->use_existing_labels = true;
$mod->custom_fields->addFieldObject($fieldObject);
}
}
if(!$installed){
$GLOBALS['log']->debug('Could not install custom field ' . $field['name'] . ' for module ' . $field['module'] . ': Module does not exist');
}
}
}
function uninstall_custom_fields($fields){
global $beanList, $beanFiles;
require_once('modules/DynamicFields/DynamicField.php');
$dyField = new DynamicField();
foreach($fields as $field){
$class = $beanList[ $field['module']];
if(file_exists($beanFiles[$class])){
require_once($beanFiles[$class]);
$mod = new $class();
$dyField->bean = $mod;
$dyField->module = $field['module'];
$dyField->deleteField($field['name']);
}
}
}
/*
* ModuleInstaller->install_relationships calls install_relationship for every file included in the module package that defines a relationship, and then
* writes a custom/Extension/application/Ext/TableDictionary/$module.php file containing an include_once for every relationship metadata file passed to install_relationship.
* 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
* everything in 'Ext/TableDictionary/' into 'tabledictionary.ext.php'
*/
function install_relationships ()
{
if (isset ( $this->installdefs [ 'relationships' ] ))
{
$this->log ( translate ( 'LBL_MI_IN_RELATIONSHIPS' ) ) ;
$str = "<?php \n //WARNING: The contents of this file are auto-generated\n" ;
$save_table_dictionary = false ;
if (! file_exists ( "custom/Extension/application/Ext/TableDictionary" ))
{
mkdir_recursive ( "custom/Extension/application/Ext/TableDictionary", true ) ;
}
foreach ( $this->installdefs [ 'relationships' ] as $key => $relationship )
{
$filename = basename ( $relationship [ 'meta_data' ] ) ;
$this->copy_path ( $relationship [ 'meta_data' ], 'custom/metadata/' . $filename ) ;
$this->install_relationship ( 'custom/metadata/' . $filename ) ;
$save_table_dictionary = true ;
if (! empty ( $relationship [ 'module_vardefs' ] ))
{
$relationship [ 'module_vardefs' ] = str_replace ( '<basepath>', $this->base_dir, $relationship [ 'module_vardefs' ] ) ;
$this->install_vardef ( $relationship [ 'module_vardefs' ], $relationship [ 'module' ] ) ;
}
if (! empty ( $relationship [ 'module_layoutdefs' ] ))
{
$relationship [ 'module_layoutdefs' ] = str_replace ( '<basepath>', $this->base_dir, $relationship [ 'module_layoutdefs' ] ) ;
$this->install_layoutdef ( $relationship [ 'module_layoutdefs' ], $relationship [ 'module' ] ) ;
}
$relName = strpos($filename, "MetaData") !== false ? substr($filename, 0, strlen($filename) - 12) : $filename;
$out = sugar_fopen ( "custom/Extension/application/Ext/TableDictionary/$relName.php", 'w' ) ;
fwrite ( $out, $str . "include('custom/metadata/$filename');\n\n?>" ) ;
fclose ( $out ) ;
}
$this->rebuild_vardefs () ;
$this->rebuild_layoutdefs () ;
if ($save_table_dictionary)
{
$this->rebuild_tabledictionary () ;
}
}
}
/*
* Install_relationship obtains a set of relationship definitions from the filename passed in as a parameter.
* For each definition it calls db->createTableParams to build the relationships table if it does not exist,
* and SugarBean::createRelationshipMeta to add the relationship into the 'relationships' table.
*/
function install_relationship($file)
{
$_REQUEST['moduleInstaller'] = true;
if(!file_exists($file))
{
$GLOBALS['log']->debug( 'File does not exists : '.$file);
return;
}
include($file);
$rel_dictionary = $dictionary;
foreach ($rel_dictionary as $rel_name => $rel_data)
{
$table = ''; // table is actually optional
// check if we have a table definition - not all relationships require a join table
if ( isset( $rel_data[ 'table' ] ) )
{
$table = $rel_data[ 'table' ];
if(!$this->db->tableExists($table))
{
$this->db->createTableParams($table, $rel_data[ 'fields' ], $rel_data[ 'indices' ]);
}
}
if(!$this->silent)
$GLOBALS['log']->debug("Processing relationship meta for ". $rel_name."...");
SugarBean::createRelationshipMeta($rel_name, $this->db,$table,$rel_dictionary,'');
Relationship::delete_cache();
if(!$this->silent)
$GLOBALS['log']->debug( 'done<br>');
}
}
function install_layoutfields() {
if (!empty ( $this->installdefs [ 'layoutfields' ] ))
{
foreach ( $this->installdefs [ 'layoutfields' ] as $fieldSet )
{
if (!empty($fieldSet['additional_fields']))
{
$this->addFieldsToLayout($fieldSet['additional_fields']);
}
}
}
}
function uninstall_layoutfields() {
if (!empty ( $this->installdefs [ 'layoutfields' ] ))
{
foreach ( $this->installdefs [ 'layoutfields' ] as $fieldSet )
{
if (!empty($fieldSet['additional_fields']))
{
$this->removeFieldsFromLayout($fieldSet['additional_fields']);
}
}
}
}