include/SugarObjects/VardefManager.php

   1 <?php
   2 /*********************************************************************************
   3  * SugarCRM Community Edition is a customer relationship management program developed by
   4  * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
   5  *
   6  * This program is free software; you can redistribute it and/or modify it under
   7  * the terms of the GNU Affero General Public License version 3 as published by the
   8  * Free Software Foundation with the addition of the following permission added
   9  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  10  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  11  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  12  *
  13  * This program is distributed in the hope that it will be useful, but WITHOUT
  14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  15  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  16  * details.
  17  *
  18  * You should have received a copy of the GNU Affero General Public License along with
  19  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  20  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21  * 02110-1301 USA.
  22  *
  23  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  24  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  25  *
  26  * The interactive user interfaces in modified source and object code versions
  27  * of this program must display Appropriate Legal Notices, as required under
  28  * Section 5 of the GNU Affero General Public License version 3.
  29  *
  30  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  31  * these Appropriate Legal Notices must retain the display of the "Powered by
  32  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  33  * technical reasons, the Appropriate Legal Notices must display the words
  34  * "Powered by SugarCRM".
  35  ********************************************************************************/
  36
  37
  38
  39 class VardefManager{
  40         static $custom_disabled_modules = array();
  41     static $linkFields;
  42
  43     /**
  44          * this method is called within a vardefs.php file which extends from a SugarObject.
  45          * It is meant to load the vardefs from the SugarObject.
  46      */
  47     static function createVardef($module, $object, $templates = array('default'), $object_name = false)
  48     {
  49         global $dictionary;
  50
  51         include_once('modules/TableDictionary.php');
  52
  53         //reverse the sort order so priority goes highest to lowest;
  54         $templates = array_reverse($templates);
  55         foreach ($templates as $template)
  56         {
  57             VardefManager::addTemplate($module, $object, $template, $object_name);
  58         }
  59         LanguageManager::createLanguageFile($module, $templates);
  60
  61         if (isset(VardefManager::$custom_disabled_modules[$module]))
  62         {
  63             $vardef_paths = array(
  64                 'custom/modules/' . $module . '/Ext/Vardefs/vardefs.ext.php',
  65                 'custom/Extension/modules/' . $module . '/Ext/Vardefs/vardefs.php'
  66             );
  67
  68             //search a predefined set of locations for the vardef files
  69             foreach ($vardef_paths as $path)
  70             {
  71                 if (file_exists($path)) {
  72                     require($path);
  73                 }
  74             }
  75         }
  76     }
  77
  78         /**
  79          * Enables/Disables the loading of custom vardefs for a module.
  80          * @param String $module Module to be enabled/disabled
  81          * @param Boolean $enable true to enable, false to disable
  82          * @return  null
  83          */
  84         public static function setCustomAllowedForModule($module, $enable) {
  85                 if ($enable && isset($custom_disabled_modules[$module])) {
  86                         unset($custom_disabled_modules[$module]);
  87                 } else if (!$enable) {
  88                         $custom_disabled_modules[$module] = true;
  89                 }
  90         }
  91
  92         static function addTemplate($module, $object, $template, $object_name=false){
  93                 if($template == 'default')$template = 'basic';
  94                 $templates = array();
  95                 $fields = array();
  96                 if(empty($object_name))$object_name = $object;
  97                 $_object_name = strtolower($object_name);
  98                 if(!empty($GLOBALS['dictionary'][$object]['table'])){
  99                         $table_name = $GLOBALS['dictionary'][$object]['table'];
 100                 }else{
 101                         $table_name = strtolower($module);
 102                 }
 103
 104                 if(empty($templates[$template])){
 105                         $path = 'include/SugarObjects/templates/' . $template . '/vardefs.php';
 106                         if(file_exists($path)){
 107                                 require($path);
 108                                 $templates[$template] = $vardefs;
 109                         }else{
 110                                 $path = 'include/SugarObjects/implements/' . $template . '/vardefs.php';
 111                                 if(file_exists($path)){
 112                                         require($path);
 113                                         $templates[$template] = $vardefs;
 114                                 }
 115                         }
 116                 }
 117
 118                 if(!empty($templates[$template])){
 119                         if(empty($GLOBALS['dictionary'][$object]['fields']))$GLOBALS['dictionary'][$object]['fields'] = array();
 120                         if(empty($GLOBALS['dictionary'][$object]['relationships']))$GLOBALS['dictionary'][$object]['relationships'] = array();
 121                         if(empty($GLOBALS['dictionary'][$object]['indices']))$GLOBALS['dictionary'][$object]['indices'] = array();
 122                         $GLOBALS['dictionary'][$object]['fields'] = array_merge($templates[$template]['fields'], $GLOBALS['dictionary'][$object]['fields']);
 123                         if(!empty($templates[$template]['relationships']))$GLOBALS['dictionary'][$object]['relationships'] = array_merge($templates[$template]['relationships'], $GLOBALS['dictionary'][$object]['relationships']);
 124                         if(!empty($templates[$template]['indices']))$GLOBALS['dictionary'][$object]['indices'] = array_merge($templates[$template]['indices'], $GLOBALS['dictionary'][$object]['indices']);
 125                         // maintain a record of this objects inheritance from the SugarObject templates...
 126             $GLOBALS['dictionary'][$object]['templates'][ $template ] = $template ;
 127                 }
 128
 129         }
 130
 131     /**
 132      * Remove invalid field definitions
 133      * @static
 134      * @param Array $fieldDefs
 135      * @return  Array
 136      */
 137     static function cleanVardefs($fieldDefs)
 138         {
 139                 foreach($fieldDefs as $field => $defs)
 140                 {
 141                         if (empty($def['name']) || empty($def['type']))
 142                         {
 143                                 unset($fieldDefs[$field]);
 144                         }
 145                 }
 146
 147                 return $fieldDefs;
 148         }
 149
 150         /**
 151          * Save the dictionary object to the cache
 152          * @param string $module the name of the module
 153          * @param string $object the name of the object
 154          */
 155         static function saveCache($module,$object, $additonal_objects= array()){
 156
 157                 $file = create_cache_directory('modules/' . $module . '/' . $object . 'vardefs.php');
 158                 write_array_to_file('GLOBALS["dictionary"]["'. $object . '"]',$GLOBALS['dictionary'][$object], $file);
 159                 if ( sugar_is_file($file) && is_readable($file)) {
 160                     include($file);
 161                 }
 162
 163                 // put the item in the sugar cache.
 164                 $key = "VardefManager.$module.$object";
 165         //Sometimes bad definitions can get in from left over extensions or file system lag(caching). We need to clean those.
 166                 $data = self::cleanVardefs($GLOBALS['dictionary'][$object]);
 167                 sugar_cache_put($key,$data);
 168         }
 169
 170         /**
 171          * clear out the vardef cache. If we receive a module name then just clear the vardef cache for that module
 172          * otherwise clear out the cache for every module
 173          * @param string module_dir the module_dir to clear, if not specified then clear
 174          *                      clear vardef cache for all modules.
 175          * @param string object_name the name of the object we are clearing this is for sugar_cache
 176          */
 177         static function clearVardef($module_dir = '', $object_name = ''){
 178                 //if we have a module name specified then just remove that vardef file
 179                 //otherwise go through each module and remove the vardefs.php
 180                 if(!empty($module_dir) && !empty($object_name)){
 181                         VardefManager::_clearCache($module_dir, $object_name);
 182                 }else{
 183                         global $beanList;
 184                         foreach($beanList as $module_dir => $object_name){
 185                                 VardefManager::_clearCache($module_dir, $object_name);
 186                         }
 187                 }
 188         }
 189
 190         /**
 191          * PRIVATE function used within clearVardefCache so we do not repeat logic
 192          * @param string module_dir the module_dir to clear
 193          * @param string object_name the name of the object we are clearing this is for sugar_cache
 194          */
 195         static function _clearCache($module_dir = '', $object_name = ''){
 196                 if(!empty($module_dir) && !empty($object_name)){
 197
 198                         if($object_name == 'aCase') {
 199                                 $object_name = 'Case';
 200                         }
 201
 202                         $file = $GLOBALS['sugar_config']['cache_dir'].'modules/'.$module_dir.'/' . $object_name . 'vardefs.php';
 203                         if(file_exists($file)){
 204                                 unlink($file);
 205                                 $key = "VardefManager.$module_dir.$object_name";
 206                                 sugar_cache_clear($key);
 207                         }
 208                 }
 209         }
 210
 211         /**
 212          * Given a module, search all of the specified locations, and any others as specified
 213          * in order to refresh the cache file
 214          *
 215          * @param string $module the given module we want to load the vardefs for
 216          * @param string $object the given object we wish to load the vardefs for
 217          * @param array $additional_search_paths an array which allows a consumer to pass in additional vardef locations to search
 218          */
 219         static function refreshVardefs($module, $object, $additional_search_paths = null, $cacheCustom = true){
 220                 // Some of the vardefs do not correctly define dictionary as global.  Declare it first.
 221                 global $dictionary, $beanList;
 222                 $vardef_paths = array(
 223                                         'modules/'.$module.'/vardefs.php',
 224                                         'custom/modules/'.$module.'/Ext/Vardefs/vardefs.ext.php',
 225                                         'custom/Extension/modules/'.$module.'/Ext/Vardefs/vardefs.php'
 226                                  );
 227
 228                 // Add in additional search paths if they were provided.
 229                 if(!empty($additional_search_paths) && is_array($additional_search_paths))
 230                 {
 231                         $vardef_paths = array_merge($vardef_paths, $additional_search_paths);
 232                 }
 233                 $found = false;
 234                 //search a predefined set of locations for the vardef files
 235                 foreach($vardef_paths as $path){
 236                         if(file_exists($path)){
 237                                 require($path);
 238                 $found = true;
 239                         }
 240                 }
 241         //Some modules have multiple beans, we need to see if this object has a module_dir that is different from its module_name
 242         if(!$found){
 243             $temp = BeanFactory::newBean($module);
 244             if ($temp && $temp->module_dir != $temp->module_name && !empty($beanList[$temp->module_dir]))
 245             {
 246                 self::refreshVardefs($temp->module_dir, $beanList[$temp->module_dir], $additional_search_paths, $cacheCustom);
 247             }
 248         }
 249
 250                 //load custom fields into the vardef cache
 251                 if($cacheCustom){
 252                         require_once("modules/DynamicFields/DynamicField.php");
 253                         $df = new DynamicField ($module) ;
 254                 $df->buildCache($module);
 255                 }
 256
 257                 //great! now that we have loaded all of our vardefs.
 258                 //let's go save them to the cache file.
 259                 if(!empty($GLOBALS['dictionary'][$object])) {
 260                         VardefManager::saveCache($module, $object);
 261         }
 262         }
 263
 264     /**
 265      * @static
 266      * @param  $module
 267      * @param  $object
 268      * @return array|bool  returns a list of all fields in the module of type 'link'.
 269      */
 270     protected static function getLinkFieldsForModule($module, $object)
 271     {
 272         global $dictionary;
 273         if($object == 'aCase') {
 274             $object = 'Case';
 275         }
 276         if (empty($dictionary[$object])) {
 277             self::loadVardef($module, $object);
 278         }
 279         if (empty($dictionary[$object]))
 280         {
 281             $GLOBALS['log']->debug("Failed to load vardefs for $module:$object in linkFieldsForModule<br/>");
 282             return false;
 283         }
 284
 285         //Cache link fields for this call in a static variable
 286         if (!isset(self::$linkFields))
 287             self::$linkFields = array();
 288
 289         if (isset(self::$linkFields[$object]))
 290             return self::$linkFields[$object];
 291
 292         $vardef = $dictionary[$object];
 293         $links = array();
 294         foreach($vardef['fields'] as $name => $def)
 295         {
 296             //Look through all link fields for related modules that have calculated fields that use that relationship
 297             if(!empty($def['type']) && $def['type'] == 'link' && !empty($def['relationship']))
 298             {
 299                 $links[$name] = $def;
 300             }
 301         }
 302         return $links;
 303     }
 304
 305
 306     public static function getLinkFieldForRelationship($module, $object, $relName)
 307     {
 308         $relLinkFields = self::getLinkFieldsForModule($module, $object);
 309         $matches = array();
 310         if (!empty($relLinkFields))
 311         {
 312             foreach($relLinkFields as $rfName => $rfDef)
 313             {
 314                 if ($rfDef['relationship'] == $relName)
 315                 {
 316                     $matches[] = $rfDef;
 317                 }
 318             }
 319         }
 320         if (empty($matches))
 321             return false;
 322         if (sizeof($matches) == 1)
 323             return $matches[0];
 324         //For relationships where both sides are the same module, more than one link will be returned
 325         return $matches;
 326     }
 327
 328
 329         /**
 330          * apply global "account_required" setting if possible
 331          * @param array    $vardef
 332          * @return array   updated $vardef
 333          */
 334     static function applyGlobalAccountRequirements($vardef)
 335     {
 336         if (isset($GLOBALS['sugar_config']['require_accounts'])) {
 337             if (isset($vardef['fields']) &&
 338                 isset($vardef['fields']['account_name']) &&
 339                 isset($vardef['fields']['account_name']['required']))
 340             {
 341                 $vardef['fields']['account_name']['required'] = $GLOBALS['sugar_config']['require_accounts'];
 342             }
 343
 344         }
 345
 346         return $vardef;
 347     }
 348
 349         /**
 350          * load the vardefs for a given module and object
 351          * @param string $module the given module we want to load the vardefs for
 352          * @param string $object the given object we wish to load the vardefs for
 353          * @param bool   $refresh whether or not we wish to refresh the cache file.
 354          */
 355         static function loadVardef($module, $object, $refresh=false){
 356                 //here check if the cache file exists, if it does then load it, if it doesn't
 357                 //then call refreshVardef
 358                 //if either our session or the system is set to developerMode then refresh is set to true
 359                 if(!empty($GLOBALS['sugar_config']['developerMode']) || !empty($_SESSION['developerMode'])){
 360                 $refresh = true;
 361         }
 362                 // Retrieve the vardefs from cache.
 363                 $key = "VardefManager.$module.$object";
 364
 365                 if(!$refresh)
 366                 {
 367                         $return_result = sugar_cache_retrieve($key);
 368                         $return_result = self::applyGlobalAccountRequirements($return_result);
 369
 370                         if(!empty($return_result))
 371                         {
 372                                 $GLOBALS['dictionary'][$object] = $return_result;
 373                                 return;
 374                         }
 375                 }
 376
 377                 // Some of the vardefs do not correctly define dictionary as global.  Declare it first.
 378                 global $dictionary;
 379                 if(empty($GLOBALS['dictionary'][$object]) || $refresh){
 380                         //if the consumer has demanded a refresh or the cache/modules... file
 381                         //does not exist, then we should do out and try to reload things
 382                         if($refresh || !file_exists($GLOBALS['sugar_config']['cache_dir'].'modules/'. $module . '/' . $object . 'vardefs.php')){
 383                                 VardefManager::refreshVardefs($module, $object);
 384                         }
 385
 386                         //at this point we should have the cache/modules/... file
 387                         //which was created from the refreshVardefs so let's try to load it.
 388                         if(file_exists($GLOBALS['sugar_config']['cache_dir'].'modules/'. $module .  '/' . $object . 'vardefs.php'))
 389                         {
 390                             if ( is_readable($GLOBALS['sugar_config']['cache_dir'].'modules/'. $module .  '/' . $object . 'vardefs.php') )
 391                 {
 392                                 include_once($GLOBALS['sugar_config']['cache_dir'].'modules/'. $module .  '/' . $object . 'vardefs.php');
 393                                 }
 394                                 // now that we hae loaded the data from disk, put it in the cache.
 395                                 if(!empty($GLOBALS['dictionary'][$object]))
 396                 {
 397                                     $GLOBALS['dictionary'][$object] = self::applyGlobalAccountRequirements($GLOBALS['dictionary'][$object]);
 398                                         sugar_cache_put($key,$GLOBALS['dictionary'][$object]);
 399                                 }
 400                         }
 401                 }
 402         }
 403 }