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         if (empty($GLOBALS['dictionary'][$object]))
 158             $object = BeanFactory::getObjectName($module);
 159         $file = create_cache_directory('modules/' . $module . '/' . $object . 'vardefs.php');
 160         write_array_to_file('GLOBALS["dictionary"]["'. $object . '"]',$GLOBALS['dictionary'][$object], $file);
 161         if ( sugar_is_file($file) && is_readable($file)) {
 162             include($file);
 163         }
 164
 165         // put the item in the sugar cache.
 166         $key = "VardefManager.$module.$object";
 167         //Sometimes bad definitions can get in from left over extensions or file system lag(caching). We need to clean those.
 168         $data = self::cleanVardefs($GLOBALS['dictionary'][$object]);
 169         sugar_cache_put($key,$data);
 170     }
 171
 172     /**
 173      * clear out the vardef cache. If we receive a module name then just clear the vardef cache for that module
 174      * otherwise clear out the cache for every module
 175      * @param string module_dir the module_dir to clear, if not specified then clear
 176      *                      clear vardef cache for all modules.
 177      * @param string object_name the name of the object we are clearing this is for sugar_cache
 178      */
 179     static function clearVardef($module_dir = '', $object_name = ''){
 180         //if we have a module name specified then just remove that vardef file
 181         //otherwise go through each module and remove the vardefs.php
 182         if(!empty($module_dir) && !empty($object_name)){
 183             VardefManager::_clearCache($module_dir, $object_name);
 184         }else{
 185             global $beanList;
 186             foreach($beanList as $module_dir => $object_name){
 187                 VardefManager::_clearCache($module_dir, $object_name);
 188             }
 189         }
 190     }
 191
 192     /**
 193      * PRIVATE function used within clearVardefCache so we do not repeat logic
 194      * @param string module_dir the module_dir to clear
 195      * @param string object_name the name of the object we are clearing this is for sugar_cache
 196      */
 197     static function _clearCache($module_dir = '', $object_name = ''){
 198         if(!empty($module_dir) && !empty($object_name)){
 199
 200             //Some modules like cases have a bean name that doesn't match the object name
 201             if (empty($GLOBALS['dictionary'][$object_name])) {
 202                 $newName = BeanFactory::getObjectName($module_dir);
 203                 $object_name = $newName != false ? $newName : $object_name;
 204             }
 205
 206             $file = $GLOBALS['sugar_config']['cache_dir'].'modules/'.$module_dir.'/' . $object_name . 'vardefs.php';
 207             if(file_exists($file)){
 208                 unlink($file);
 209                 $key = "VardefManager.$module_dir.$object_name";
 210                 sugar_cache_clear($key);
 211             }
 212         }
 213     }
 214
 215     /**
 216      * Given a module, search all of the specified locations, and any others as specified
 217      * in order to refresh the cache file
 218      *
 219      * @param string $module the given module we want to load the vardefs for
 220      * @param string $object the given object we wish to load the vardefs for
 221      * @param array $additional_search_paths an array which allows a consumer to pass in additional vardef locations to search
 222      */
 223     static function refreshVardefs($module, $object, $additional_search_paths = null, $cacheCustom = true, $params = array()){
 224         // Some of the vardefs do not correctly define dictionary as global.  Declare it first.
 225         global $dictionary, $beanList;
 226         $vardef_paths = array(
 227                     'modules/'.$module.'/vardefs.php',
 228                     'custom/modules/'.$module.'/Ext/Vardefs/vardefs.ext.php',
 229                     'custom/Extension/modules/'.$module.'/Ext/Vardefs/vardefs.php'
 230                  );
 231
 232         // Add in additional search paths if they were provided.
 233         if(!empty($additional_search_paths) && is_array($additional_search_paths))
 234         {
 235             $vardef_paths = array_merge($vardef_paths, $additional_search_paths);
 236         }
 237         $found = false;
 238         //search a predefined set of locations for the vardef files
 239         foreach($vardef_paths as $path){
 240             if(file_exists($path)){
 241                 require($path);
 242                 $found = true;
 243             }
 244         }
 245         //Some modules have multiple beans, we need to see if this object has a module_dir that is different from its module_name
 246         if(!$found){
 247             $temp = BeanFactory::newBean($module);
 248             if ($temp)
 249             {
 250                 $object_name = BeanFactory::getObjectName($temp->module_dir);
 251                 if ($temp && $temp->module_dir != $temp->module_name && !empty($object_name))
 252                 {
 253                     self::refreshVardefs($temp->module_dir, $object_name, $additional_search_paths, $cacheCustom);
 254                 }
 255             }
 256         }
 257
 258         //Some modules like cases have a bean name that doesn't match the object name
 259         if (empty($dictionary[$object])) {
 260             $newName = BeanFactory::getObjectName($module);
 261             $object = $newName != false ? $newName : $object;
 262         }
 263
 264         //load custom fields into the vardef cache
 265         if($cacheCustom){
 266             require_once("modules/DynamicFields/DynamicField.php");
 267             $df = new DynamicField ($module) ;
 268             $df->buildCache($module);
 269         }
 270
 271         //great! now that we have loaded all of our vardefs.
 272         //let's go save them to the cache file.
 273         if(!empty($dictionary[$object])) {
 274             VardefManager::saveCache($module, $object);
 275         }
 276     }
 277
 278     /**
 279      * @static
 280      * @param  $module
 281      * @param  $object
 282      * @return array|bool  returns a list of all fields in the module of type 'link'.
 283      */
 284     protected static function getLinkFieldsForModule($module, $object)
 285     {
 286         global $dictionary;
 287         //Some modules like cases have a bean name that doesn't match the object name
 288         if (empty($dictionary[$object])) {
 289             $newName = BeanFactory::getObjectName($module);
 290             $object = $newName != false ? $newName : $object;
 291         }
 292         if (empty($dictionary[$object])) {
 293             self::loadVardef($module, $object, false, array('ignore_rel_calc_fields' => true));
 294         }
 295         if (empty($dictionary[$object]))
 296         {
 297             $GLOBALS['log']->debug("Failed to load vardefs for $module:$object in linkFieldsForModule<br/>");
 298             return false;
 299         }
 300
 301         //Cache link fields for this call in a static variable
 302         if (!isset(self::$linkFields))
 303             self::$linkFields = array();
 304
 305         if (isset(self::$linkFields[$object]))
 306             return self::$linkFields[$object];
 307
 308         $vardef = $dictionary[$object];
 309         $links = array();
 310         foreach($vardef['fields'] as $name => $def)
 311         {
 312             //Look through all link fields for related modules that have calculated fields that use that relationship
 313             if(!empty($def['type']) && $def['type'] == 'link' && !empty($def['relationship']))
 314             {
 315                 $links[$name] = $def;
 316             }
 317         }
 318         return $links;
 319     }
 320
 321
 322     public static function getLinkFieldForRelationship($module, $object, $relName)
 323     {
 324         $relLinkFields = self::getLinkFieldsForModule($module, $object);
 325         $matches = array();
 326         if (!empty($relLinkFields))
 327         {
 328             foreach($relLinkFields as $rfName => $rfDef)
 329             {
 330                 if ($rfDef['relationship'] == $relName)
 331                 {
 332                     $matches[] = $rfDef;
 333                 }
 334             }
 335         }
 336         if (empty($matches))
 337             return false;
 338         if (sizeof($matches) == 1)
 339             return $matches[0];
 340         //For relationships where both sides are the same module, more than one link will be returned
 341         return $matches;
 342     }
 343
 344
 345     /**
 346      * apply global "account_required" setting if possible
 347      * @param array    $vardef
 348      * @return array   updated $vardef
 349      */
 350     static function applyGlobalAccountRequirements($vardef)
 351     {
 352         if (isset($GLOBALS['sugar_config']['require_accounts'])) {
 353             if (isset($vardef['fields']) &&
 354                 isset($vardef['fields']['account_name']) &&
 355                 isset($vardef['fields']['account_name']['required']))
 356             {
 357                 $vardef['fields']['account_name']['required'] = $GLOBALS['sugar_config']['require_accounts'];
 358             }
 359
 360         }
 361
 362         return $vardef;
 363     }
 364
 365     /**
 366      * load the vardefs for a given module and object
 367      * @param string $module the given module we want to load the vardefs for
 368      * @param string $object the given object we wish to load the vardefs for
 369      * @param bool   $refresh whether or not we wish to refresh the cache file.
 370      */
 371     static function loadVardef($module, $object, $refresh=false, $params = array()){
 372         //here check if the cache file exists, if it does then load it, if it doesn't
 373         //then call refreshVardef
 374         //if either our session or the system is set to developerMode then refresh is set to true
 375         if(!empty($GLOBALS['sugar_config']['developerMode']) || !empty($_SESSION['developerMode'])){
 376             $refresh = true;
 377         }
 378         // Retrieve the vardefs from cache.
 379         $key = "VardefManager.$module.$object";
 380
 381         if(!$refresh)
 382         {
 383             $return_result = sugar_cache_retrieve($key);
 384             $return_result = self::applyGlobalAccountRequirements($return_result);
 385
 386             if(!empty($return_result))
 387             {
 388                 $GLOBALS['dictionary'][$object] = $return_result;
 389                 return;
 390             }
 391         }
 392
 393         // Some of the vardefs do not correctly define dictionary as global.  Declare it first.
 394         global $dictionary;
 395         if(empty($GLOBALS['dictionary'][$object]) || $refresh){
 396             //if the consumer has demanded a refresh or the cache/modules... file
 397             //does not exist, then we should do out and try to reload things
 398             if($refresh || !file_exists($GLOBALS['sugar_config']['cache_dir'].'modules/'. $module . '/' . $object . 'vardefs.php')){
 399                 VardefManager::refreshVardefs($module, $object, null, true, $params);
 400             }
 401
 402             //at this point we should have the cache/modules/... file
 403             //which was created from the refreshVardefs so let's try to load it.
 404             if(file_exists($GLOBALS['sugar_config']['cache_dir'].'modules/'. $module .  '/' . $object . 'vardefs.php'))
 405             {
 406                 if ( is_readable($GLOBALS['sugar_config']['cache_dir'].'modules/'. $module .  '/' . $object . 'vardefs.php') )
 407                 {
 408                     include_once($GLOBALS['sugar_config']['cache_dir'].'modules/'. $module .  '/' . $object . 'vardefs.php');
 409                 }
 410                 // now that we hae loaded the data from disk, put it in the cache.
 411                 if(!empty($GLOBALS['dictionary'][$object]))
 412                 {
 413                     $GLOBALS['dictionary'][$object] = self::applyGlobalAccountRequirements($GLOBALS['dictionary'][$object]);
 414                     sugar_cache_put($key,$GLOBALS['dictionary'][$object]);
 415                 }
 416             }
 417         }
 418     }
 419 }