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-2011 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 ********************************************************************************/
38 /*********************************************************************************
40 * Description: Defines the English language pack for the base application.
41 * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
42 * All Rights Reserved.
43 * Contributor(s): ______________________________________..
44 ********************************************************************************/
47 * This is the base class that all other SugarMerge objects extend
52 * The variable name that is used with the file for example in editviewdefs and detailviewdefs it is $viewdefs
56 protected $varName = 'viewdefs';
58 * Enter the name of the parameter used in the $varName for example in editviewdefs and detailviewdefs it is 'EditView' and 'DetailView' respectively - $viewdefs['EditView']
62 protected $viewDefs = 'EditView';
64 * this will store the meta data for the original file
68 protected $originalData = array();
70 * this will store the meta data for the new file
74 protected $newData = array();
76 * this will store the meta data for the custom file
80 protected $customData = array();
82 * this will store an associative array contianing all the fields that are used in the original meta data file
86 protected $originalFields = array();
88 * this will store an associative array contianing all the fields that are used in the new meta data file
92 protected $newFields = array();
94 * this will store an associative array contianing all the fields that are used in the custom meta data file
98 protected $customFields = array();
100 * this will store an associative array contianing all the merged fields
104 protected $mergedFields = array();
106 * the name of the module to be merged
110 protected $module = 'module';
112 * the max number of columns for this view
116 protected $maxCols = 2;
118 * If we should use the best match algorithim
122 protected $bestMatch = true;
124 * The default panel we place the fields in if we aren't using the best match algorithim
128 protected $defaultPanel = 'default';
130 * The name of the panels section in the meta data
134 protected $panelName = 'panels';
136 * The name of the templateMeta data secion in the meta data
138 protected $templateMetaName = 'templateMeta';
140 * The file pointer to log to if set to NULL it will use the GLOBALS['log'] if available and log to debug
144 protected $fp = NULL;
148 * Determines if getFields should analyze panels to determine if it is a MultiPanel
152 protected $scanForMultiPanel = true;
155 * If true then it works as though it's a multipanel
159 protected $isMultiPanel = true;
163 * The ids of the panels found in custom metadata fuke
166 protected $customPanelIds = array();
170 * The ids of the panels found in original metadata fuke
173 protected $originalPanelIds = array();
177 * The ids of the panels found in original metadata fuke
180 protected $newPanelIds = array();
184 * Special case conversion
187 protected $fieldConversionMapping = array(
188 'Campaigns' => array('created_by_name'=>'date_entered', 'modified_by_name'=>'date_modified'),
189 'Cases' => array('created_by_name'=>'date_entered', 'modified_by_name'=>'date_modified'),
190 'Contracts' => array('created_by_name'=>'date_entered', 'modified_by_name'=>'date_modified'),
191 'Leads' => array('created_by'=>'date_entered'),
192 'Meetings' => array('created_by_name'=>'date_entered', 'modified_by_name'=>'date_modified'),
193 'ProspectLists' => array('created_by_name'=>'date_entered', 'modified_by_name'=>'date_modified'),
194 'Prospects' => array('created_by_name'=>'date_entered', 'modified_by_name'=>'date_modified'),
195 'Tasks' => array('created_by_name'=>'date_entered', 'modified_by_name'=>'date_modified'),
199 * Clears out the values of the arrays so that the same object can be utilized
202 protected function clear(){
203 unset($this->newData);
204 $this->newData = array();
205 unset($this->customData);
206 $this->customData = array();
207 unset($this->originalData);
208 $this->originalData = array();
209 unset($this->newFields);
210 $this->newFields = array();
211 unset($this->customFields);
212 $this->customFields = array();
213 unset($this->originalFields);
214 $this->originalFields = array();
215 unset($this->mergedFields);
216 $this->mergedFields = array();
217 unset($this->mergeData);
218 $this->mergeData = array();
219 $this->defaultPanel = 'default';
223 * Allows the user to choose to use the best match algorithim or not
227 public function setBestMatch($on=true){
228 $this->bestMatch = $on;
233 * Allows users to set the name to use as the default panel in the meta data
235 * @param STRING $name - name of the default panel
237 public function setDefaultPanel($name = 'default'){
238 $this->defaultPanel = $name;
242 * Allows the user to set a filepointer that is already open to log to
244 * @param FILEPOINTER $fp
246 public function setLogFilePointer($fp){
251 * opens the file with the 'a' parameter and use it to log messages to
253 * @param STRING $file - path to file we wish to log to
255 public function setLogFile($file){
256 $this->fp = fopen($file, 'a');
263 * returns true if $val1 and $val2 match otherwise it returns false
265 * @param MULTI $val1 - a value to compare to val2
266 * @param MULTI $val2 - a value to compare to val1
267 * @return BOOLEAN - if $val1 and $val2 match
269 protected function areMatchingValues($val1, $val2){
270 if(!is_array($val1)){
271 //if val2 is an array and val1 isn't then it isn't a match
275 //otherwise both are not arrays so we can return a comparison between them
276 return $val1 == $val2;
278 //if val1 is an array and val2 isn't then it isn't a match
279 if(!is_array($val2)){
283 foreach($val1 as $k=>$v){
284 if(!isset($val2[$k]))return false;
285 if(!$this->areMatchingValues($val1[$k], $val2[$k])){
291 //this implies that there are still values left so the two must not match since we unset any matching values
299 * Recursiveley merges two arrays
301 * @param ARRAY $gimp - if keys match this arrays values are overriden
302 * @param ARRAY $dom - if keys match this arrays values will override the others
303 * @return ARRAY $merged - the merges array
305 function arrayMerge($gimp, $dom) {
306 if(is_array($gimp) && is_array($dom)) {
307 foreach($dom as $domKey => $domVal) {
308 if(isset($gimp[$domKey])) {
309 if(is_array($domVal)) {
310 $gimp[$domKey] = $this->arrayMerge($gimp[$domKey], $dom[$domKey]);
312 $gimp[$domKey] = $domVal;
315 $gimp[$domKey] = $domVal;
323 * Merges the meta data of a single field
325 * @param ARRAY $orig - the original meta-data for this field
326 * @param ARRAY $new - the new meta-data for this field
327 * @param ARRAY $custom - the custom meta-data for this field
328 * @return ARRAY $merged - the merged meta-data
330 protected function mergeField($orig, $new, $custom){
331 $orig_custom = $this->areMatchingValues($orig, $custom);
332 $new_custom = $this->areMatchingValues($new, $custom);
333 // if both are true then there is nothing to merge since all three fields match
334 if(!($orig_custom && $new_custom)){
335 $this->log('merging field');
336 $this->log('original meta-data');
338 $this->log('new meta-data');
340 $this->log('custom meta-data');
342 $this->log('merged meta-data');
347 //if orignal and custom match always take the new value or if new and custom match
348 if($orig_custom || $new_custom){
352 //if original and new match always take the custom
353 if($this->areMatchingValues($orig, $new)){
358 if(is_array($custom)) {
359 //if both new and custom are arrays then at this point new != custom and orig != custom and orig != new so let's merge the custom and the new and return that
361 $new = $this->arrayMerge($custom, $new);
365 //otherwise we know that new is not an array and custom has been 'customized' so let's keep those customizations.
370 //default to returning the New version of the field
376 * Merges the fields together and stores them in $this->mergedFields
379 protected function mergeFields() {
380 foreach($this->customFields as $field=>$data) {
381 //if we have this field in both the new fields and the original fields - it has existed since the last install/upgrade
382 if(isset($this->newFields[$field]) && isset($this->originalFields[$field])){
383 //if both the custom field and the original match then we take the location of the custom field since it hasn't moved
384 $loc = $this->customFields[$field]['loc'];
385 $loc['source'] = 'custom';
389 //Address fields present a special problem...
390 if(preg_match('/(alt_|primary_|billing_|shipping_)address_street/i', $field, $matches)) {
391 $prefix = $matches[1];
392 $city = $prefix . 'address_city';
393 $postal_code = $prefix . 'address_postalcode';
394 $state = $prefix . 'address_state';
395 $country = $prefix . 'address_country';
397 if(isset($this->customFields[$city]) ||
398 isset($this->customFields[$postal_code]) ||
399 isset($this->customFields[$state]) ||
400 isset($this->customFields[$country])) {
402 $this->mergedFields[$field] = array(
403 'data'=>$this->customFields[$field]['data'],
409 //but we still merge the meta data of the three
410 $this->mergedFields[$field] = array(
411 'data'=>$this->mergeField($this->originalFields[$field]['data'], $this->newFields[$field]['data'], $this->customFields[$field]['data']),
414 //if it's not set in the new fields then it was a custom field or an original field so we take the custom fields data and set the location source to custom
415 } else if(!isset($this->newFields[$field])){
416 $this->mergedFields[$field] = $data;
417 $this->mergedFields[$field]['loc']['source'] = 'custom';
419 //otherwise the field is in both new and custom but not in the orignal so we merge the new and custom data together and take the location from the custom
420 $this->mergedFields[$field] = array(
421 'data'=>$this->mergeField('', $this->newFields[$field]['data'], $this->customFields[$field]['data']),
422 'loc'=>$this->customFields[$field]['loc']);
424 $this->mergedFields[$field]['loc']['source'] = 'custom';
425 //echo var_export($this->mergedFields[$field], true);
428 //then we clear out the field from
429 unset($this->originalFields[$field]);
430 unset($this->customFields[$field]);
431 unset($this->newFields[$field]);
436 * These are fields that were removed by the customer
438 foreach($this->originalFields as $field=>$data){
439 unset($this->originalFields[$field]);
440 unset($this->newFields[$field]);
444 * These are fields that were added by sugar
446 $new_field_panel = $this->defaultPanel;
447 foreach($this->customPanelIds as $custom_panel_ids=>$panels) {
448 $new_field_panel = $custom_panel_ids;
451 foreach($this->newFields as $field=>$data){
452 $data['loc']['source']= 'new';
453 $data['loc']['panel'] = $new_field_panel;
454 $this->mergedFields[$field] = array(
455 'data'=>$data['data'],
456 'loc'=>$data['loc']);
457 unset($this->newFields[$field]);
462 * Walks through the merged fields and places them in the appropriate place based on their location parameter as well as the choosen algorithim
464 * @return ARRAY $panels - the new panels section for the merged file
466 protected function buildPanels(){
469 $panel_keys = array_keys($this->customPanelIds);
470 $this->defaultPanel = end($panel_keys);
472 foreach($this->mergedFields as $field_id=>$field){
473 //If this field is in a panel not defined in the custom layout, set it to default panel
474 if(!isset($this->customPanelIds[$field['loc']['panel']])) {
475 $field['loc']['panel'] = $this->defaultPanel;
478 if($field['loc']['source'] == 'new') {
479 if($this->bestMatch){
480 //for best match as long as the column is filled let's keep walking down till we can fill it
481 $row = end(array_keys($this->customData[$this->module][$this->viewDefs][$this->panelName][$field['loc']['panel']]));
483 while(!empty($panels[$field['loc']['panel']][$row][$col])){
490 //row should be at a point that there is no field in this location
491 $panels[$field['loc']['panel']][$row][$col] = $field['data'];
493 //so for not best match we place it in the default panel at the first available column for the row
495 while(!empty($panels[$this->defaultPanel][$row][$field['loc']['col']])){
498 $panels[$field['loc']['panel']][$row][$field['loc']['col']] = $field['data'];
501 $panels[$field['loc']['panel']][$field['loc']['row']][$field['loc']['col']] = $field['data'];
507 foreach($panels as $k=>$panel){
508 foreach($panel as $r=>$row){
509 ksort($panels[$k][$r]);
518 * Merge the templateMeta entry for the view defs. Also assume that any changes made in the custom files should
519 * have precedence since they must be changed manually, even over new files that may be provided in the upgarde
523 protected function mergeTemplateMeta()
525 //this is to handle the situation in Calls/Meetings where we updated the templateMeta and will fail if we don't update this.
526 //long term we should not do this and should provide a way for calls/meetings to update themselves.
527 if( isset($this->customData[$this->module][$this->viewDefs][$this->templateMetaName]) && (!$this->module == 'Calls' || !$this->module == 'Meetings') )
528 $this->newData[$this->module][$this->viewDefs][$this->templateMetaName] = $this->customData[$this->module][$this->viewDefs][$this->templateMetaName];
532 * Sets the panel section for the meta-data after it has been merged
535 protected function setPanels(){
536 $this->newData[$this->module][$this->viewDefs][$this->panelName] = $this->buildPanels();
538 if(!$this->isMultiPanel) {
539 $this->newData[$this->module][$this->viewDefs][$this->panelName] = $this->newData[$this->module][$this->viewDefs][$this->panelName][$this->defaultPanel];
545 * Parses out the fields for each files meta data and then calls on mergeFields and setPanels
548 protected function mergeMetaData(){
549 $this->originalFields = $this->getFields($this->originalData[$this->module][$this->viewDefs][$this->panelName]);
550 $this->originalPanelIds = $this->getPanelIds($this->originalData[$this->module][$this->viewDefs][$this->panelName]);
551 $this->customFields = $this->getFields($this->customData[$this->module][$this->viewDefs][$this->panelName]);
552 $this->customPanelIds = $this->getPanelIds($this->customData[$this->module][$this->viewDefs][$this->panelName]);
553 $this->newFields = $this->getFields($this->newData[$this->module][$this->viewDefs][$this->panelName]);
554 //echo var_export($this->newFields, true);
555 $this->newPanelIds = $this->getPanelIds($this->newData[$this->module][$this->viewDefs][$this->panelName]);
556 $this->mergeFields();
557 $this->mergeTemplateMeta();
561 * This takes in a list of panels and returns an associative array of field names to the meta-data of the field as well as the locations of that field
563 * @param ARRAY $panels - this is the 'panel' section of the meta-data
564 * @return ARRAY $fields - an associate array of fields and their meta-data as well as their location
566 protected function getFields(&$panels){
570 $setDefaultPanel = false;
572 if(count($panels) == 1) {
573 $arrayKeys = array_keys($panels);
574 if(!empty($arrayKeys[0])) {
575 $this->defaultPanel = $arrayKeys[0];
576 $panels = $panels[$arrayKeys[0]];
578 $panels = $panels[''];
580 $setDefaultPanel = true;
583 if($this->scanForMultiPanel){
584 require_once('include/SugarFields/Parsers/MetaParser.php');
585 if($setDefaultPanel || !MetaParser::hasMultiplePanels($panels)) {
586 $panels = array($this->defaultPanel=>$panels);
587 $this->isMultiPanel = false;
591 //echo "---------------------------------------------------------\n";
592 //echo var_export($panels, true);
594 foreach($panels as $panel_id=>$panel){
595 foreach($panel as $row_id=>$rows){
596 foreach($rows as $col_id=>$col){
598 $field_name = 'BLANK_' . $blanks;
601 $field_name = is_array($col) && isset($col['name']) ? $col['name'] : $col;
603 if(!empty($col['name'])) {
604 $field_name = $col['name'];
611 if(is_string($field_name)) {
612 // We need to replace all instances of the fake uploadfile field with the real filename field
613 if ( $field_name == 'uploadfile' && !empty($col['customCode'])) {
614 $replaceField = false;
615 if ( !empty($col['customCode']) ) {
616 $replaceField = true;
617 unset($col['customCode']);
620 if( !empty($col['displayParams']) && !empty($col['displayParams']['link']) ) {
621 $replaceField = true;
624 if ( $replaceField ) {
625 $field_name = 'filename';
626 $col['name'] = 'filename';
629 $fields[$field_name] = array('data'=>$col, 'loc'=>array('panel'=>"{$panel_id}", 'row'=>"{$row_id}", 'col'=>"{$col_id}"));
635 //echo "---------------------------------------------------------\n";
636 //echo var_export($fields, true);
646 protected function getPanelIds($panels){
648 $panel_ids = array();
649 $setDefaultPanel = false;
651 if(count($panels) == 1) {
652 $arrayKeys = array_keys($panels);
653 if(!empty($arrayKeys[0])) {
654 $this->defaulPanel = $arrayKeys[0];
655 $panels = $panels[$arrayKeys[0]];
657 $panels = $panels[''];
659 $setDefaultPanel = true;
662 if($this->scanForMultiPanel){
663 require_once('include/SugarFields/Parsers/MetaParser.php');
664 if($setDefaultPanel || !MetaParser::hasMultiplePanels($panels)) {
665 $panels = array($this->defaultPanel=>$panels);
666 $this->isMultiPanel = false;
670 foreach($panels as $panel_id=>$panel){
671 $panel_ids[$panel_id] = $panel_id;
678 * Loads the meta data of the original, new, and custom file into the variables originalData, newData, and customData respectively
680 * @param STRING $module - name of the module's files that are to be merged
681 * @param STRING $original_file - path to the file that originally shipped with sugar
682 * @param STRING $new_file - path to the new file that is shipping with the patch
683 * @param STRING $custom_file - path to the custom file
685 protected function loadData($module, $original_file, $new_file, $custom_file){
686 $this->module = $module;
687 $varnmame = $this->varName;
688 require($original_file);
689 $this->originalData = $$varnmame;
691 $this->newData = $$varnmame;
692 if(file_exists($custom_file)){
693 require($custom_file);
694 $this->customData = $$varnmame;
696 $this->customData = $this->originalData;
701 * This will save the merged data to a file
703 * @param STRING $to - path of the file to save it to
704 * @return BOOLEAN - success or failure of the save
706 public function save($to){
707 return write_array_to_file("viewdefs['$this->module']['$this->viewDefs']", $this->newData[$this->module][$this->viewDefs], $to);
711 * This will return the meta data of the merged file
713 * @return ARRAY - the meta data of the merged file
715 public function getData(){
716 return $this->newData;
720 * public function that will merge meta data from an original sugar file that shipped with the product, a customized file, and a new file shipped with an upgrade
722 * @param STRING $module - name of the module's files that are to be merged
723 * @param STRING $original_file - path to the file that originally shipped with sugar
724 * @param STRING $new_file - path to the new file that is shipping with the patch
725 * @param STRING $custom_file - path to the custom file
726 * @param BOOLEAN $save - boolean on if it should save the results to the custom file or not
727 * @return BOOLEAN - if the merged file was saved if false is passed in for the save parameter it always returns true
729 public function merge($module, $original_file, $new_file, $custom_file=false, $save=true){
731 $this->log("\n\n". 'Starting a merge in ' . get_class($this));
732 $this->log('merging the following files');
733 $this->log('original file:' . $original_file);
734 $this->log('new file:' . $new_file);
735 $this->log('custom file:' . $custom_file);
736 if(empty($custom_file) && $save){
739 $this->loadData($module, $original_file, $new_file, $custom_file);
740 $this->mergeMetaData();
741 if($save && !empty($this->newData) && !empty($custom_file)){
743 copy($custom_file, $custom_file . '.suback.php');
744 return $this->save($custom_file);
747 if(!$save)return true;
751 * Logs the given message if the message is not a string it will export it first. If $this->fp is NULL then it will try to log to the $GLOBALS['log'] if it is available
753 * @param MULTI $message
755 protected function log($message){
756 if(!is_string($message)){
757 $message = var_export($message, true);
759 if(!empty($this->fp)){
760 fwrite($this->fp, $message. "\n");
762 if(!empty($GLOBALS['log'])){
763 $GLOBALS['log']->debug($message . "\n");