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          * Save the dictionary object to the cache
 133          * @param string $module the name of the module
 134          * @param string $object the name of the object
 135          */
 136         static function saveCache($module,$object, $additonal_objects= array()){
 137
 138                 $file = create_cache_directory('modules/' . $module . '/' . $object . 'vardefs.php');
 139                 write_array_to_file('GLOBALS["dictionary"]["'. $object . '"]',$GLOBALS['dictionary'][$object], $file);
 140                 if ( is_readable($file) ) {
 141                     include($file);
 142                 }
 143
 144                 // put the item in the sugar cache.
 145                 $key = "VardefManager.$module.$object";
 146                 $data = $GLOBALS['dictionary'][$object];
 147                 sugar_cache_put($key,$data);
 148         }
 149
 150         /**
 151          * clear out the vardef cache. If we receive a module name then just clear the vardef cache for that module
 152          * otherwise clear out the cache for every module
 153          * @param string module_dir the module_dir to clear, if not specified then clear
 154          *                      clear vardef cache for all modules.
 155          * @param string object_name the name of the object we are clearing this is for sugar_cache
 156          */
 157         static function clearVardef($module_dir = '', $object_name = ''){
 158                 //if we have a module name specified then just remove that vardef file
 159                 //otherwise go through each module and remove the vardefs.php
 160                 if(!empty($module_dir) && !empty($object_name)){
 161                         VardefManager::_clearCache($module_dir, $object_name);
 162                 }else{
 163                         global $beanList;
 164                         foreach($beanList as $module_dir => $object_name){
 165                                 VardefManager::_clearCache($module_dir, $object_name);
 166                         }
 167                 }
 168         }
 169
 170         /**
 171          * PRIVATE function used within clearVardefCache so we do not repeat logic
 172          * @param string module_dir the module_dir to clear
 173          * @param string object_name the name of the object we are clearing this is for sugar_cache
 174          */
 175         static function _clearCache($module_dir = '', $object_name = ''){
 176                 if(!empty($module_dir) && !empty($object_name)){
 177
 178                         if($object_name == 'aCase') {
 179                                 $object_name = 'Case';
 180                         }
 181
 182                         $file = $GLOBALS['sugar_config']['cache_dir'].'modules/'.$module_dir.'/' . $object_name . 'vardefs.php';
 183                         if(file_exists($file)){
 184                                 unlink($file);
 185                                 $key = "VardefManager.$module_dir.$object_name";
 186                                 sugar_cache_clear($key);
 187                         }
 188                 }
 189         }
 190
 191         /**
 192          * Given a module, search all of the specified locations, and any others as specified
 193          * in order to refresh the cache file
 194          *
 195          * @param string $module the given module we want to load the vardefs for
 196          * @param string $object the given object we wish to load the vardefs for
 197          * @param array $additional_search_paths an array which allows a consumer to pass in additional vardef locations to search
 198          */
 199         static function refreshVardefs($module, $object, $additional_search_paths = null, $cacheCustom = true){
 200                 // Some of the vardefs do not correctly define dictionary as global.  Declare it first.
 201                 global $dictionary;
 202                 $vardef_paths = array(
 203                                         'modules/'.$module.'/vardefs.php',
 204                                         'custom/modules/'.$module.'/Ext/Vardefs/vardefs.ext.php',
 205                                         'custom/Extension/modules/'.$module.'/Ext/Vardefs/vardefs.php'
 206                                  );
 207
 208                 // Add in additional search paths if they were provided.
 209                 if(!empty($additional_search_paths) && is_array($additional_search_paths))
 210                 {
 211                         $vardef_paths = array_merge($vardef_paths, $additional_search_paths);
 212                 }
 213                 //search a predefined set of locations for the vardef files
 214                 foreach($vardef_paths as $path){
 215                         if(file_exists($path)){
 216
 217                                 require($path);
 218                         }
 219                 }
 220
 221                 //load custom fields into the vardef cache
 222                 if($cacheCustom){
 223                         require_once("modules/DynamicFields/DynamicField.php");
 224                         $df = new DynamicField ($module) ;
 225                 $df->buildCache($module);
 226                 }
 227
 228                 //great! now that we have loaded all of our vardefs.
 229                 //let's go save them to the cache file.
 230                 if(!empty($GLOBALS['dictionary'][$object])) {
 231                         VardefManager::saveCache($module, $object);
 232         }
 233         }
 234
 235
 236         /**
 237          * load the vardefs for a given module and object
 238          * @param string $module the given module we want to load the vardefs for
 239          * @param string $object the given object we wish to load the vardefs for
 240          * @param bool   $refresh whether or not we wish to refresh the cache file.
 241          */
 242         static function loadVardef($module, $object, $refresh=false){
 243                 //here check if the cache file exists, if it does then load it, if it doesn't
 244                 //then call refreshVardef
 245                 //if either our session or the system is set to developerMode then refresh is set to true
 246                 if(!empty($GLOBALS['sugar_config']['developerMode']) || !empty($_SESSION['developerMode'])){
 247                 $refresh = true;
 248         }
 249                 // Retrieve the vardefs from cache.
 250                 $key = "VardefManager.$module.$object";
 251
 252                 if(!$refresh)
 253                 {
 254                         $return_result = sugar_cache_retrieve($key);
 255                         if(!empty($return_result))
 256                         {
 257                                 $GLOBALS['dictionary'][$object] = $return_result;
 258                                 return;
 259                         }
 260                 }
 261
 262                 // Some of the vardefs do not correctly define dictionary as global.  Declare it first.
 263                 global $dictionary;
 264                 if(empty($GLOBALS['dictionary'][$object]) || $refresh){
 265                         //if the consumer has demanded a refresh or the cache/modules... file
 266                         //does not exist, then we should do out and try to reload things
 267                         if($refresh || !file_exists($GLOBALS['sugar_config']['cache_dir'].'modules/'. $module . '/' . $object . 'vardefs.php')){
 268                                 VardefManager::refreshVardefs($module, $object);
 269                         }
 270
 271                         //at this point we should have the cache/modules/... file
 272                         //which was created from the refreshVardefs so let's try to load it.
 273                         if(file_exists($GLOBALS['sugar_config']['cache_dir'].'modules/'. $module .  '/' . $object . 'vardefs.php'))
 274                         {
 275                             if ( is_readable($GLOBALS['sugar_config']['cache_dir'].'modules/'. $module .  '/' . $object . 'vardefs.php') ) {
 276                                 include_once($GLOBALS['sugar_config']['cache_dir'].'modules/'. $module .  '/' . $object . 'vardefs.php');
 277                                 }
 278                                 // now that we hae loaded the data from disk, put it in the cache.
 279                                 if(!empty($GLOBALS['dictionary'][$object]))
 280                                         sugar_cache_put($key,$GLOBALS['dictionary'][$object]);
 281                         }
 282                 }
 283         }
 284 }