/include/SugarObjects/VardefManager.php
PHP | 308 lines | 172 code | 34 blank | 102 comment | 45 complexity | 477ceccd79bb1010d3fcf21de33e7b0e MD5 | raw file
- <?php
- /*********************************************************************************
- * SugarCRM Community Edition is a customer relationship management program developed by
- * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
- *
- * This program is free software; you can redistribute it and/or modify it under
- * the terms of the GNU Affero General Public License version 3 as published by the
- * Free Software Foundation with the addition of the following permission added
- * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
- * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
- * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
- *
- * This program is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
- * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
- * details.
- *
- * You should have received a copy of the GNU Affero General Public License along with
- * this program; if not, see http://www.gnu.org/licenses or write to the Free
- * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
- * 02110-1301 USA.
- *
- * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
- * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
- *
- * The interactive user interfaces in modified source and object code versions
- * of this program must display Appropriate Legal Notices, as required under
- * Section 5 of the GNU Affero General Public License version 3.
- *
- * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
- * these Appropriate Legal Notices must retain the display of the "Powered by
- * SugarCRM" logo. If the display of the logo is not reasonably feasible for
- * technical reasons, the Appropriate Legal Notices must display the words
- * "Powered by SugarCRM".
- ********************************************************************************/
- class VardefManager{
- static $custom_disabled_modules = array();
- static $linkFields;
- /**
- * this method is called within a vardefs.php file which extends from a SugarObject.
- * It is meant to load the vardefs from the SugarObject.
- */
- static function createVardef($module, $object, $templates = array('default'), $object_name = false)
- {
- global $dictionary;
- include_once('modules/TableDictionary.php');
- //reverse the sort order so priority goes highest to lowest;
- $templates = array_reverse($templates);
- foreach ($templates as $template)
- {
- VardefManager::addTemplate($module, $object, $template, $object_name);
- }
- LanguageManager::createLanguageFile($module, $templates);
- if (isset(VardefManager::$custom_disabled_modules[$module]))
- {
- $vardef_paths = array(
- 'custom/modules/' . $module . '/Ext/Vardefs/vardefs.ext.php',
- 'custom/Extension/modules/' . $module . '/Ext/Vardefs/vardefs.php'
- );
- //search a predefined set of locations for the vardef files
- foreach ($vardef_paths as $path)
- {
- if (file_exists($path)) {
- require($path);
- }
- }
- }
- }
- /**
- * Enables/Disables the loading of custom vardefs for a module.
- * @param String $module Module to be enabled/disabled
- * @param Boolean $enable true to enable, false to disable
- * @return null
- */
- public static function setCustomAllowedForModule($module, $enable) {
- if ($enable && isset($custom_disabled_modules[$module])) {
- unset($custom_disabled_modules[$module]);
- } else if (!$enable) {
- $custom_disabled_modules[$module] = true;
- }
- }
- static function addTemplate($module, $object, $template, $object_name=false){
- if($template == 'default')$template = 'basic';
- $templates = array();
- $fields = array();
- if(empty($object_name))$object_name = $object;
- $_object_name = strtolower($object_name);
- if(!empty($GLOBALS['dictionary'][$object]['table'])){
- $table_name = $GLOBALS['dictionary'][$object]['table'];
- }else{
- $table_name = strtolower($module);
- }
- if(empty($templates[$template])){
- $path = 'include/SugarObjects/templates/' . $template . '/vardefs.php';
- if(file_exists($path)){
- require($path);
- $templates[$template] = $vardefs;
- }else{
- $path = 'include/SugarObjects/implements/' . $template . '/vardefs.php';
- if(file_exists($path)){
- require($path);
- $templates[$template] = $vardefs;
- }
- }
- }
- if(!empty($templates[$template])){
- if(empty($GLOBALS['dictionary'][$object]['fields']))$GLOBALS['dictionary'][$object]['fields'] = array();
- if(empty($GLOBALS['dictionary'][$object]['relationships']))$GLOBALS['dictionary'][$object]['relationships'] = array();
- if(empty($GLOBALS['dictionary'][$object]['indices']))$GLOBALS['dictionary'][$object]['indices'] = array();
- $GLOBALS['dictionary'][$object]['fields'] = array_merge($templates[$template]['fields'], $GLOBALS['dictionary'][$object]['fields']);
- if(!empty($templates[$template]['relationships']))$GLOBALS['dictionary'][$object]['relationships'] = array_merge($templates[$template]['relationships'], $GLOBALS['dictionary'][$object]['relationships']);
- if(!empty($templates[$template]['indices']))$GLOBALS['dictionary'][$object]['indices'] = array_merge($templates[$template]['indices'], $GLOBALS['dictionary'][$object]['indices']);
- // maintain a record of this objects inheritance from the SugarObject templates...
- $GLOBALS['dictionary'][$object]['templates'][ $template ] = $template ;
- }
- }
- /**
- * Save the dictionary object to the cache
- * @param string $module the name of the module
- * @param string $object the name of the object
- */
- static function saveCache($module,$object, $additonal_objects= array()){
- $file = create_cache_directory('modules/' . $module . '/' . $object . 'vardefs.php');
- write_array_to_file('GLOBALS["dictionary"]["'. $object . '"]',$GLOBALS['dictionary'][$object], $file);
- if ( is_readable($file) ) {
- include($file);
- }
- // put the item in the sugar cache.
- $key = "VardefManager.$module.$object";
- $data = $GLOBALS['dictionary'][$object];
- sugar_cache_put($key,$data);
- }
- /**
- * clear out the vardef cache. If we receive a module name then just clear the vardef cache for that module
- * otherwise clear out the cache for every module
- * @param string module_dir the module_dir to clear, if not specified then clear
- * clear vardef cache for all modules.
- * @param string object_name the name of the object we are clearing this is for sugar_cache
- */
- static function clearVardef($module_dir = '', $object_name = ''){
- //if we have a module name specified then just remove that vardef file
- //otherwise go through each module and remove the vardefs.php
- if(!empty($module_dir) && !empty($object_name)){
- VardefManager::_clearCache($module_dir, $object_name);
- }else{
- global $beanList;
- foreach($beanList as $module_dir => $object_name){
- VardefManager::_clearCache($module_dir, $object_name);
- }
- }
- }
- /**
- * PRIVATE function used within clearVardefCache so we do not repeat logic
- * @param string module_dir the module_dir to clear
- * @param string object_name the name of the object we are clearing this is for sugar_cache
- */
- static function _clearCache($module_dir = '', $object_name = ''){
- if(!empty($module_dir) && !empty($object_name)){
- if($object_name == 'aCase') {
- $object_name = 'Case';
- }
- $file = $GLOBALS['sugar_config']['cache_dir'].'modules/'.$module_dir.'/' . $object_name . 'vardefs.php';
- if(file_exists($file)){
- unlink($file);
- $key = "VardefManager.$module_dir.$object_name";
- sugar_cache_clear($key);
- }
- }
- }
- /**
- * Given a module, search all of the specified locations, and any others as specified
- * in order to refresh the cache file
- *
- * @param string $module the given module we want to load the vardefs for
- * @param string $object the given object we wish to load the vardefs for
- * @param array $additional_search_paths an array which allows a consumer to pass in additional vardef locations to search
- */
- static function refreshVardefs($module, $object, $additional_search_paths = null, $cacheCustom = true){
- // Some of the vardefs do not correctly define dictionary as global. Declare it first.
- global $dictionary;
- $vardef_paths = array(
- 'modules/'.$module.'/vardefs.php',
- 'custom/modules/'.$module.'/Ext/Vardefs/vardefs.ext.php',
- 'custom/Extension/modules/'.$module.'/Ext/Vardefs/vardefs.php'
- );
- // Add in additional search paths if they were provided.
- if(!empty($additional_search_paths) && is_array($additional_search_paths))
- {
- $vardef_paths = array_merge($vardef_paths, $additional_search_paths);
- }
- //search a predefined set of locations for the vardef files
- foreach($vardef_paths as $path){
- if(file_exists($path)){
- require($path);
- }
- }
- //load custom fields into the vardef cache
- if($cacheCustom){
- require_once("modules/DynamicFields/DynamicField.php");
- $df = new DynamicField ($module) ;
- $df->buildCache($module);
- }
- //great! now that we have loaded all of our vardefs.
- //let's go save them to the cache file.
- if(!empty($GLOBALS['dictionary'][$object])) {
- VardefManager::saveCache($module, $object);
- }
- }
- /**
- * apply global "account_required" setting if possible
- * @param array $vardef
- * @return array updated $vardef
- */
- static function applyGlobalAccountRequirements($vardef)
- {
- if (isset($GLOBALS['sugar_config']['require_accounts'])) {
- if (isset($vardef['fields']) &&
- isset($vardef['fields']['account_name']) &&
- isset($vardef['fields']['account_name']['required']))
- {
- $vardef['fields']['account_name']['required'] = $GLOBALS['sugar_config']['require_accounts'];
- }
- }
- return $vardef;
- }
- /**
- * load the vardefs for a given module and object
- * @param string $module the given module we want to load the vardefs for
- * @param string $object the given object we wish to load the vardefs for
- * @param bool $refresh whether or not we wish to refresh the cache file.
- */
- static function loadVardef($module, $object, $refresh=false){
- //here check if the cache file exists, if it does then load it, if it doesn't
- //then call refreshVardef
- //if either our session or the system is set to developerMode then refresh is set to true
- if(!empty($GLOBALS['sugar_config']['developerMode']) || !empty($_SESSION['developerMode'])){
- $refresh = true;
- }
- // Retrieve the vardefs from cache.
- $key = "VardefManager.$module.$object";
- if(!$refresh)
- {
- $return_result = sugar_cache_retrieve($key);
- $return_result = self::applyGlobalAccountRequirements($return_result);
- if(!empty($return_result))
- {
- $GLOBALS['dictionary'][$object] = $return_result;
- return;
- }
- }
- // Some of the vardefs do not correctly define dictionary as global. Declare it first.
- global $dictionary;
- if(empty($GLOBALS['dictionary'][$object]) || $refresh){
- //if the consumer has demanded a refresh or the cache/modules... file
- //does not exist, then we should do out and try to reload things
- if($refresh || !file_exists($GLOBALS['sugar_config']['cache_dir'].'modules/'. $module . '/' . $object . 'vardefs.php')){
- VardefManager::refreshVardefs($module, $object);
- }
- //at this point we should have the cache/modules/... file
- //which was created from the refreshVardefs so let's try to load it.
- if(file_exists($GLOBALS['sugar_config']['cache_dir'].'modules/'. $module . '/' . $object . 'vardefs.php'))
- {
- if ( is_readable($GLOBALS['sugar_config']['cache_dir'].'modules/'. $module . '/' . $object . 'vardefs.php') ) {
- include_once($GLOBALS['sugar_config']['cache_dir'].'modules/'. $module . '/' . $object . 'vardefs.php');
- }
- // now that we hae loaded the data from disk, put it in the cache.
- if(!empty($GLOBALS['dictionary'][$object])) {
- $GLOBALS['dictionary'][$object] = self::applyGlobalAccountRequirements($GLOBALS['dictionary'][$object]);
- sugar_cache_put($key,$GLOBALS['dictionary'][$object]);
- }
- }
- }
- }
- }