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