2 /*********************************************************************************
3 * SugarCRM Community Edition is a customer relationship management program developed by
4 * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
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.
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
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
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.
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.
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 ********************************************************************************/
43 static $custom_disabled_modules = array();
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.
50 static function createVardef($module, $object, $templates = array('default'), $object_name = false)
54 include_once('modules/TableDictionary.php');
56 //reverse the sort order so priority goes highest to lowest;
57 $templates = array_reverse($templates);
58 foreach ($templates as $template)
60 VardefManager::addTemplate($module, $object, $template, $object_name);
62 LanguageManager::createLanguageFile($module, $templates);
64 if (isset(VardefManager::$custom_disabled_modules[$module]))
66 $vardef_paths = array(
67 'custom/modules/' . $module . '/Ext/Vardefs/vardefs.ext.php',
68 'custom/Extension/modules/' . $module . '/Ext/Vardefs/vardefs.php'
71 //search a predefined set of locations for the vardef files
72 foreach ($vardef_paths as $path)
74 if (file_exists($path)) {
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
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;
95 static function addTemplate($module, $object, $template, $object_name=false){
96 if($template == 'default')$template = 'basic';
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'];
104 $table_name = strtolower($module);
107 if(empty($templates[$template])){
108 $path = 'include/SugarObjects/templates/' . $template . '/vardefs.php';
109 if(file_exists($path)){
111 $templates[$template] = $vardefs;
113 $path = 'include/SugarObjects/implements/' . $template . '/vardefs.php';
114 if(file_exists($path)){
116 $templates[$template] = $vardefs;
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 ;
136 * Remove invalid field definitions
138 * @param Array $fieldDefs
141 static function cleanVardefs($fieldDefs)
143 foreach($fieldDefs as $field => $defs)
145 if (empty($def['name']) || empty($def['type']))
147 unset($fieldDefs[$field]);
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
159 static function saveCache($module,$object, $additonal_objects= array()){
161 if (empty($GLOBALS['dictionary'][$object]))
162 $object = BeanFactory::getObjectName($module);
163 $file = create_cache_directory('modules/' . $module . '/' . $object . 'vardefs.php');
164 write_array_to_file('GLOBALS["dictionary"]["'. $object . '"]',$GLOBALS['dictionary'][$object], $file);
165 if ( sugar_is_file($file) && is_readable($file)) {
169 // put the item in the sugar cache.
170 $key = "VardefManager.$module.$object";
171 //Sometimes bad definitions can get in from left over extensions or file system lag(caching). We need to clean those.
172 $data = self::cleanVardefs($GLOBALS['dictionary'][$object]);
173 sugar_cache_put($key,$data);
177 * clear out the vardef cache. If we receive a module name then just clear the vardef cache for that module
178 * otherwise clear out the cache for every module
179 * @param string module_dir the module_dir to clear, if not specified then clear
180 * clear vardef cache for all modules.
181 * @param string object_name the name of the object we are clearing this is for sugar_cache
183 static function clearVardef($module_dir = '', $object_name = ''){
184 //if we have a module name specified then just remove that vardef file
185 //otherwise go through each module and remove the vardefs.php
186 if(!empty($module_dir) && !empty($object_name)){
187 VardefManager::_clearCache($module_dir, $object_name);
190 foreach($beanList as $module_dir => $object_name){
191 VardefManager::_clearCache($module_dir, $object_name);
197 * PRIVATE function used within clearVardefCache so we do not repeat logic
198 * @param string module_dir the module_dir to clear
199 * @param string object_name the name of the object we are clearing this is for sugar_cache
201 static function _clearCache($module_dir = '', $object_name = ''){
202 if(!empty($module_dir) && !empty($object_name)){
204 //Some modules like cases have a bean name that doesn't match the object name
205 if (empty($GLOBALS['dictionary'][$object_name])) {
206 $newName = BeanFactory::getObjectName($module_dir);
207 $object_name = $newName != false ? $newName : $object_name;
210 $file = sugar_cached('modules/').$module_dir.'/' . $object_name . 'vardefs.php';
212 if(file_exists($file)){
214 $key = "VardefManager.$module_dir.$object_name";
215 sugar_cache_clear($key);
221 * Given a module, search all of the specified locations, and any others as specified
222 * in order to refresh the cache file
224 * @param string $module the given module we want to load the vardefs for
225 * @param string $object the given object we wish to load the vardefs for
226 * @param array $additional_search_paths an array which allows a consumer to pass in additional vardef locations to search
228 static function refreshVardefs($module, $object, $additional_search_paths = null, $cacheCustom = true, $params = array()){
229 // Some of the vardefs do not correctly define dictionary as global. Declare it first.
230 global $dictionary, $beanList;
231 $vardef_paths = array(
232 'modules/'.$module.'/vardefs.php',
233 'custom/modules/'.$module.'/Ext/Vardefs/vardefs.ext.php',
234 'custom/Extension/modules/'.$module.'/Ext/Vardefs/vardefs.php'
237 // Add in additional search paths if they were provided.
238 if(!empty($additional_search_paths) && is_array($additional_search_paths))
240 $vardef_paths = array_merge($vardef_paths, $additional_search_paths);
243 //search a predefined set of locations for the vardef files
244 foreach($vardef_paths as $path){
245 if(file_exists($path)){
250 //Some modules have multiple beans, we need to see if this object has a module_dir that is different from its module_name
252 $temp = BeanFactory::newBean($module);
255 $object_name = BeanFactory::getObjectName($temp->module_dir);
256 if ($temp && $temp->module_dir != $temp->module_name && !empty($object_name))
258 self::refreshVardefs($temp->module_dir, $object_name, $additional_search_paths, $cacheCustom);
263 //Some modules like cases have a bean name that doesn't match the object name
264 if (empty($dictionary[$object])) {
265 $newName = BeanFactory::getObjectName($module);
266 $object = $newName != false ? $newName : $object;
269 //load custom fields into the vardef cache
271 require_once("modules/DynamicFields/DynamicField.php");
272 $df = new DynamicField ($module) ;
273 $df->buildCache($module);
276 //great! now that we have loaded all of our vardefs.
277 //let's go save them to the cache file.
278 if(!empty($dictionary[$object])) {
279 VardefManager::saveCache($module, $object);
287 * @return array|bool returns a list of all fields in the module of type 'link'.
289 protected static function getLinkFieldsForModule($module, $object)
292 //Some modules like cases have a bean name that doesn't match the object name
293 if (empty($dictionary[$object])) {
294 $newName = BeanFactory::getObjectName($module);
295 $object = $newName != false ? $newName : $object;
297 if (empty($dictionary[$object])) {
298 self::loadVardef($module, $object, false, array('ignore_rel_calc_fields' => true));
300 if (empty($dictionary[$object]))
302 $GLOBALS['log']->debug("Failed to load vardefs for $module:$object in linkFieldsForModule<br/>");
306 //Cache link fields for this call in a static variable
307 if (!isset(self::$linkFields))
308 self::$linkFields = array();
310 if (isset(self::$linkFields[$object]))
311 return self::$linkFields[$object];
313 $vardef = $dictionary[$object];
315 foreach($vardef['fields'] as $name => $def)
317 //Look through all link fields for related modules that have calculated fields that use that relationship
318 if(!empty($def['type']) && $def['type'] == 'link' && !empty($def['relationship']))
320 $links[$name] = $def;
327 public static function getLinkFieldForRelationship($module, $object, $relName)
329 $relLinkFields = self::getLinkFieldsForModule($module, $object);
331 if (!empty($relLinkFields))
333 foreach($relLinkFields as $rfName => $rfDef)
335 if ($rfDef['relationship'] == $relName)
343 if (sizeof($matches) == 1)
345 //For relationships where both sides are the same module, more than one link will be returned
352 * applyGlobalAccountRequirements
354 * This method ensures that the account_name relationships are set to always be required if the configuration file specifies
355 * so. For more information on this require_accounts parameter, please see the administrators guide or go to the
356 * developers.sugarcrm.com website to find articles relating to the use of this field.
358 * @param Array $vardef The vardefs of the module to apply the account_name field requirement to
359 * @return Array $vardef The vardefs of the module with the updated required setting based on the system configuration
361 static function applyGlobalAccountRequirements($vardef)
363 if (isset($GLOBALS['sugar_config']['require_accounts']))
365 if (isset($vardef['fields'])
366 && isset($vardef['fields']['account_name'])
367 && isset($vardef['fields']['account_name']['type'])
368 && $vardef['fields']['account_name']['type'] == 'relate'
369 && isset($vardef['fields']['account_name']['required']))
371 $vardef['fields']['account_name']['required'] = $GLOBALS['sugar_config']['require_accounts'];
380 * load the vardefs for a given module and object
381 * @param string $module the given module we want to load the vardefs for
382 * @param string $object the given object we wish to load the vardefs for
383 * @param bool $refresh whether or not we wish to refresh the cache file.
385 static function loadVardef($module, $object, $refresh=false, $params = array()){
386 //here check if the cache file exists, if it does then load it, if it doesn't
387 //then call refreshVardef
388 //if either our session or the system is set to developerMode then refresh is set to true
389 if(!empty($GLOBALS['sugar_config']['developerMode']) || !empty($_SESSION['developerMode'])){
392 // Retrieve the vardefs from cache.
393 $key = "VardefManager.$module.$object";
397 $return_result = sugar_cache_retrieve($key);
398 $return_result = self::applyGlobalAccountRequirements($return_result);
400 if(!empty($return_result))
402 $GLOBALS['dictionary'][$object] = $return_result;
407 // Some of the vardefs do not correctly define dictionary as global. Declare it first.
409 if(empty($GLOBALS['dictionary'][$object]) || $refresh){
410 //if the consumer has demanded a refresh or the cache/modules... file
411 //does not exist, then we should do out and try to reload things
413 $cachedfile = sugar_cached('modules/'). $module . '/' . $object . 'vardefs.php';
414 if($refresh || !file_exists($cachedfile)){
415 VardefManager::refreshVardefs($module, $object, null, true, $params);
418 //at this point we should have the cache/modules/... file
419 //which was created from the refreshVardefs so let's try to load it.
420 if(file_exists($cachedfile))
422 if (is_readable($cachedfile))
424 include_once($cachedfile);
426 // now that we hae loaded the data from disk, put it in the cache.
427 if(!empty($GLOBALS['dictionary'][$object]))
429 $GLOBALS['dictionary'][$object] = self::applyGlobalAccountRequirements($GLOBALS['dictionary'][$object]);
430 sugar_cache_put($key,$GLOBALS['dictionary'][$object]);