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-2012 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  * Vardefs management
  40  * @api
  41  */
  42 class VardefManager{
  43     static $custom_disabled_modules = array();
  44     static $linkFields;
  45
  46     /**
  47      * this method is called within a vardefs.php file which extends from a SugarObject.
  48      * It is meant to load the vardefs from the SugarObject.
  49      */
  50     static function createVardef($module, $object, $templates = array('default'), $object_name = false)
  51     {
  52         global $dictionary;
  53
  54         include_once('modules/TableDictionary.php');
  55
  56         //reverse the sort order so priority goes highest to lowest;
  57         $templates = array_reverse($templates);
  58         foreach ($templates as $template)
  59         {
  60             VardefManager::addTemplate($module, $object, $template, $object_name);
  61         }
  62         LanguageManager::createLanguageFile($module, $templates);
  63
  64         if (isset(VardefManager::$custom_disabled_modules[$module]))
  65         {
  66             $vardef_paths = array(
  67                 'custom/modules/' . $module . '/Ext/Vardefs/vardefs.ext.php',
  68                 'custom/Extension/modules/' . $module . '/Ext/Vardefs/vardefs.php'
  69             );
  70
  71             //search a predefined set of locations for the vardef files
  72             foreach ($vardef_paths as $path)
  73             {
  74                 if (file_exists($path)) {
  75                     require($path);
  76                 }
  77             }
  78         }
  79     }
  80
  81     /**
  82      * Enables/Disables the loading of custom vardefs for a module.
  83      * @param String $module Module to be enabled/disabled
  84      * @param Boolean $enable true to enable, false to disable
  85      * @return  null
  86      */
  87     public static function setCustomAllowedForModule($module, $enable) {
  88         if ($enable && isset($custom_disabled_modules[$module])) {
  89               unset($custom_disabled_modules[$module]);
  90         } else if (!$enable) {
  91               $custom_disabled_modules[$module] = true;
  92         }
  93     }
  94
  95     static function addTemplate($module, $object, $template, $object_name=false){
  96         if($template == 'default')$template = 'basic';
  97         $templates = array();
  98         $fields = array();
  99         if(empty($object_name))$object_name = $object;
 100         $_object_name = strtolower($object_name);
 101         if(!empty($GLOBALS['dictionary'][$object]['table'])){
 102             $table_name = $GLOBALS['dictionary'][$object]['table'];
 103         }else{
 104             $table_name = strtolower($module);
 105         }
 106
 107         if(empty($templates[$template])){
 108             $path = 'include/SugarObjects/templates/' . $template . '/vardefs.php';
 109             if(file_exists($path)){
 110                 require($path);
 111                 $templates[$template] = $vardefs;
 112             }else{
 113                 $path = 'include/SugarObjects/implements/' . $template . '/vardefs.php';
 114                 if(file_exists($path)){
 115                     require($path);
 116                     $templates[$template] = $vardefs;
 117                 }
 118             }
 119         }
 120
 121         if(!empty($templates[$template])){
 122             if(empty($GLOBALS['dictionary'][$object]['fields']))$GLOBALS['dictionary'][$object]['fields'] = array();
 123             if(empty($GLOBALS['dictionary'][$object]['relationships']))$GLOBALS['dictionary'][$object]['relationships'] = array();
 124             if(empty($GLOBALS['dictionary'][$object]['indices']))$GLOBALS['dictionary'][$object]['indices'] = array();
 125             $GLOBALS['dictionary'][$object]['fields'] = array_merge($templates[$template]['fields'], $GLOBALS['dictionary'][$object]['fields']);
 126             if(!empty($templates[$template]['relationships']))$GLOBALS['dictionary'][$object]['relationships'] = array_merge($templates[$template]['relationships'], $GLOBALS['dictionary'][$object]['relationships']);
 127             if(!empty($templates[$template]['indices']))$GLOBALS['dictionary'][$object]['indices'] = array_merge($templates[$template]['indices'], $GLOBALS['dictionary'][$object]['indices']);
 128             // maintain a record of this objects inheritance from the SugarObject templates...
 129             $GLOBALS['dictionary'][$object]['templates'][ $template ] = $template ;
 130         }
 131
 132     }
 133
 134
 135     /**
 136      * Remove invalid field definitions
 137      * @static
 138      * @param Array $fieldDefs
 139      * @return  Array
 140      */
 141     static function cleanVardefs($fieldDefs)
 142     {
 143         foreach($fieldDefs as $field => $defs)
 144         {
 145             if (empty($def['name']) || empty($def['type']))
 146             {
 147                 unset($fieldDefs[$field]);
 148             }
 149         }
 150
 151         return $fieldDefs;
 152     }
 153
 154     /**
 155      * Save the dictionary object to the cache
 156      * @param string $module the name of the module
 157      * @param string $object the name of the object
 158      */
 159     static function saveCache($module,$object, $additonal_objects= array()){
 160
 161         if (empty($GLOBALS['dictionary'][$object]))
 162             $object = BeanFactory::getObjectName($module);
 163         $file = create_cache_directory('modules/' . $module . '/' . $object . 'vardefs.php');
 164
 165         $out="<?php \n \$GLOBALS[\"dictionary\"][\"". $object . "\"]=" . var_export($GLOBALS['dictionary'][$object], true) .";";
 166         sugar_file_put_contents_atomic($file, $out);
 167         if ( sugar_is_file($file) && is_readable($file)) {
 168             include($file);
 169         }
 170
 171         // put the item in the sugar cache.
 172         $key = "VardefManager.$module.$object";
 173         //Sometimes bad definitions can get in from left over extensions or file system lag(caching). We need to clean those.
 174         $data = self::cleanVardefs($GLOBALS['dictionary'][$object]);
 175         sugar_cache_put($key,$data);
 176     }
 177
 178     /**
 179      * clear out the vardef cache. If we receive a module name then just clear the vardef cache for that module
 180      * otherwise clear out the cache for every module
 181      * @param string module_dir the module_dir to clear, if not specified then clear
 182      *                      clear vardef cache for all modules.
 183      * @param string object_name the name of the object we are clearing this is for sugar_cache
 184      */
 185     static function clearVardef($module_dir = '', $object_name = ''){
 186         //if we have a module name specified then just remove that vardef file
 187         //otherwise go through each module and remove the vardefs.php
 188         if(!empty($module_dir) && !empty($object_name)){
 189             VardefManager::_clearCache($module_dir, $object_name);
 190         }else{
 191             global $beanList;
 192             foreach($beanList as $module_dir => $object_name){
 193                 VardefManager::_clearCache($module_dir, $object_name);
 194             }
 195         }
 196     }
 197
 198     /**
 199      * PRIVATE function used within clearVardefCache so we do not repeat logic
 200      * @param string module_dir the module_dir to clear
 201      * @param string object_name the name of the object we are clearing this is for sugar_cache
 202      */
 203     static function _clearCache($module_dir = '', $object_name = ''){
 204         if(!empty($module_dir) && !empty($object_name)){
 205
 206             //Some modules like cases have a bean name that doesn't match the object name
 207             if (empty($GLOBALS['dictionary'][$object_name])) {
 208                 $newName = BeanFactory::getObjectName($module_dir);
 209                 $object_name = $newName != false ? $newName : $object_name;
 210             }
 211
 212             $file = sugar_cached('modules/').$module_dir.'/' . $object_name . 'vardefs.php';
 213
 214             if(file_exists($file)){
 215                 unlink($file);
 216                 $key = "VardefManager.$module_dir.$object_name";
 217                 sugar_cache_clear($key);
 218             }
 219         }
 220     }
 221
 222     /**
 223      * Given a module, search all of the specified locations, and any others as specified
 224      * in order to refresh the cache file
 225      *
 226      * @param string $module the given module we want to load the vardefs for
 227      * @param string $object the given object we wish to load the vardefs for
 228      * @param array $additional_search_paths an array which allows a consumer to pass in additional vardef locations to search
 229      */
 230     static function refreshVardefs($module, $object, $additional_search_paths = null, $cacheCustom = true, $params = array()){
 231         // Some of the vardefs do not correctly define dictionary as global.  Declare it first.
 232         global $dictionary, $beanList;
 233         $vardef_paths = array(
 234                     'modules/'.$module.'/vardefs.php',
 235                     'custom/modules/'.$module.'/Ext/Vardefs/vardefs.ext.php',
 236                     'custom/Extension/modules/'.$module.'/Ext/Vardefs/vardefs.php'
 237                  );
 238
 239         // Add in additional search paths if they were provided.
 240         if(!empty($additional_search_paths) && is_array($additional_search_paths))
 241         {
 242             $vardef_paths = array_merge($vardef_paths, $additional_search_paths);
 243         }
 244         $found = false;
 245         //search a predefined set of locations for the vardef files
 246         foreach($vardef_paths as $path){
 247             if(file_exists($path)){
 248                 require($path);
 249                 $found = true;
 250             }
 251         }
 252         //Some modules have multiple beans, we need to see if this object has a module_dir that is different from its module_name
 253         if(!$found){
 254             $temp = BeanFactory::newBean($module);
 255             if ($temp)
 256             {
 257                 $object_name = BeanFactory::getObjectName($temp->module_dir);
 258                 if ($temp && $temp->module_dir != $temp->module_name && !empty($object_name))
 259                 {
 260                     self::refreshVardefs($temp->module_dir, $object_name, $additional_search_paths, $cacheCustom);
 261                 }
 262             }
 263         }
 264
 265         //Some modules like cases have a bean name that doesn't match the object name
 266         if (empty($dictionary[$object])) {
 267             $newName = BeanFactory::getObjectName($module);
 268             $object = $newName != false ? $newName : $object;
 269         }
 270
 271         //load custom fields into the vardef cache
 272         if($cacheCustom){
 273             require_once("modules/DynamicFields/DynamicField.php");
 274             $df = new DynamicField ($module) ;
 275             $df->buildCache($module, false);
 276         }
 277
 278         //great! now that we have loaded all of our vardefs.
 279         //let's go save them to the cache file.
 280         if(!empty($dictionary[$object])) {
 281             VardefManager::saveCache($module, $object);
 282         }
 283     }
 284
 285     /**
 286      * @static
 287      * @param  $module
 288      * @param  $object
 289      * @return array|bool  returns a list of all fields in the module of type 'link'.
 290      */
 291     protected static function getLinkFieldsForModule($module, $object)
 292     {
 293         global $dictionary;
 294         //Some modules like cases have a bean name that doesn't match the object name
 295         if (empty($dictionary[$object])) {
 296             $newName = BeanFactory::getObjectName($module);
 297             $object = $newName != false ? $newName : $object;
 298         }
 299         if (empty($dictionary[$object])) {
 300             self::loadVardef($module, $object, false, array('ignore_rel_calc_fields' => true));
 301         }
 302         if (empty($dictionary[$object]))
 303         {
 304             $GLOBALS['log']->debug("Failed to load vardefs for $module:$object in linkFieldsForModule<br/>");
 305             return false;
 306         }
 307
 308         //Cache link fields for this call in a static variable
 309         if (!isset(self::$linkFields))
 310             self::$linkFields = array();
 311
 312         if (isset(self::$linkFields[$object]))
 313             return self::$linkFields[$object];
 314
 315         $vardef = $dictionary[$object];
 316         $links = array();
 317         foreach($vardef['fields'] as $name => $def)
 318         {
 319             //Look through all link fields for related modules that have calculated fields that use that relationship
 320             if(!empty($def['type']) && $def['type'] == 'link' && !empty($def['relationship']))
 321             {
 322                 $links[$name] = $def;
 323             }
 324         }
 325         return $links;
 326     }
 327
 328
 329     public static function getLinkFieldForRelationship($module, $object, $relName)
 330     {
 331         $relLinkFields = self::getLinkFieldsForModule($module, $object);
 332         $matches = array();
 333         if (!empty($relLinkFields))
 334         {
 335             foreach($relLinkFields as $rfName => $rfDef)
 336             {
 337                 if ($rfDef['relationship'] == $relName)
 338                 {
 339                     $matches[] = $rfDef;
 340                 }
 341             }
 342         }
 343         if (empty($matches))
 344             return false;
 345         if (sizeof($matches) == 1)
 346             return $matches[0];
 347         //For relationships where both sides are the same module, more than one link will be returned
 348         return $matches;
 349     }
 350
 351
 352
 353     /**
 354      * applyGlobalAccountRequirements
 355      *
 356      * This method ensures that the account_name relationships are set to always be required if the configuration file specifies
 357      * so.  For more information on this require_accounts parameter, please see the administrators guide or go to the
 358      * developers.sugarcrm.com website to find articles relating to the use of this field.
 359      *
 360      * @param Array $vardef The vardefs of the module to apply the account_name field requirement to
 361      * @return Array $vardef The vardefs of the module with the updated required setting based on the system configuration
 362      */
 363     static function applyGlobalAccountRequirements($vardef)
 364     {
 365         if (isset($GLOBALS['sugar_config']['require_accounts']))
 366         {
 367             if (isset($vardef['fields'])
 368                 && isset($vardef['fields']['account_name'])
 369                 && isset($vardef['fields']['account_name']['type'])
 370                 && $vardef['fields']['account_name']['type'] == 'relate'
 371                 && isset($vardef['fields']['account_name']['required']))
 372             {
 373                 $vardef['fields']['account_name']['required'] = $GLOBALS['sugar_config']['require_accounts'];
 374             }
 375
 376         }
 377         return $vardef;
 378     }
 379
 380
 381     /**
 382      * load the vardefs for a given module and object
 383      * @param string $module the given module we want to load the vardefs for
 384      * @param string $object the given object we wish to load the vardefs for
 385      * @param bool   $refresh whether or not we wish to refresh the cache file.
 386      */
 387     static function loadVardef($module, $object, $refresh=false, $params = array()){
 388         //here check if the cache file exists, if it does then load it, if it doesn't
 389         //then call refreshVardef
 390         //if either our session or the system is set to developerMode then refresh is set to true
 391         if(inDeveloperMode() || !empty($_SESSION['developerMode'])){
 392             $refresh = true;
 393         }
 394         // Retrieve the vardefs from cache.
 395         $key = "VardefManager.$module.$object";
 396
 397         if(!$refresh)
 398         {
 399             $return_result = sugar_cache_retrieve($key);
 400             $return_result = self::applyGlobalAccountRequirements($return_result);
 401
 402             if(!empty($return_result))
 403             {
 404                 $GLOBALS['dictionary'][$object] = $return_result;
 405                 return;
 406             }
 407         }
 408
 409         // Some of the vardefs do not correctly define dictionary as global.  Declare it first.
 410         global $dictionary;
 411         if(empty($GLOBALS['dictionary'][$object]) || $refresh){
 412             //if the consumer has demanded a refresh or the cache/modules... file
 413             //does not exist, then we should do out and try to reload things
 414
 415                         $cachedfile = sugar_cached('modules/'). $module . '/' . $object . 'vardefs.php';
 416                         if($refresh || !file_exists($cachedfile)){
 417                                 VardefManager::refreshVardefs($module, $object, null, true, $params);
 418                         }
 419
 420             //at this point we should have the cache/modules/... file
 421             //which was created from the refreshVardefs so let's try to load it.
 422             if(file_exists($cachedfile))
 423             {
 424                 if (is_readable($cachedfile))
 425                 {
 426                     include_once($cachedfile);
 427                 }
 428                 // now that we hae loaded the data from disk, put it in the cache.
 429                 if(!empty($GLOBALS['dictionary'][$object]))
 430                 {
 431                     $GLOBALS['dictionary'][$object] = self::applyGlobalAccountRequirements($GLOBALS['dictionary'][$object]);
 432                     sugar_cache_put($key,$GLOBALS['dictionary'][$object]);
 433                 }
 434             }
 435         }
 436     }
 437
 438 }