include/SubPanel/SubPanel.php

   1 <?php
   2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
   3 /*********************************************************************************
   4  * SugarCRM Community Edition is a customer relationship management program developed by
   5  * SugarCRM, Inc. Copyright (C) 2004-2012 SugarCRM Inc.
   6  *
   7  * This program is free software; you can redistribute it and/or modify it under
   8  * the terms of the GNU Affero General Public License version 3 as published by the
   9  * Free Software Foundation with the addition of the following permission added
  10  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  11  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  12  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License along with
  20  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  21  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  22  * 02110-1301 USA.
  23  *
  24  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  25  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  26  *
  27  * The interactive user interfaces in modified source and object code versions
  28  * of this program must display Appropriate Legal Notices, as required under
  29  * Section 5 of the GNU Affero General Public License version 3.
  30  *
  31  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  32  * these Appropriate Legal Notices must retain the display of the "Powered by
  33  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  34  * technical reasons, the Appropriate Legal Notices must display the words
  35  * "Powered by SugarCRM".
  36  ********************************************************************************/
  37
  38 require_once('include/SubPanel/registered_layout_defs.php');
  39 /**
  40  * Subpanel
  41  * @api
  42  */
  43 class SubPanel
  44 {
  45         var $hideNewButton = false;
  46         var $subpanel_id;
  47         var $parent_record_id;
  48         var $parent_module;  // the name of the parent module
  49         var $parent_bean;  // the instantiated bean of the parent
  50         var $template_file;
  51         var $linked_fields;
  52         var $action = 'DetailView';
  53         var $show_select_button = true;
  54         var $subpanel_define = null;  // contains the layout_def.php
  55         var $subpanel_defs;
  56         var $subpanel_query=null;
  57     var $layout_def_key='';
  58         function SubPanel($module, $record_id, $subpanel_id, $subpanelDef, $layout_def_key='')
  59         {
  60                 global $theme, $beanList, $beanFiles, $focus, $app_strings;
  61
  62                 $this->subpanel_defs=$subpanelDef;
  63                 $this->subpanel_id = $subpanel_id;
  64                 $this->parent_record_id = $record_id;
  65                 $this->parent_module = $module;
  66         $this->layout_def_key = $layout_def_key;
  67
  68                 $this->parent_bean = $focus;
  69                 $result = $focus;
  70
  71                 if(empty($result))
  72                 {
  73                         $parent_bean_name = $beanList[$module];
  74                         $parent_bean_file = $beanFiles[$parent_bean_name];
  75                         require_once($parent_bean_file);
  76                         $this->parent_bean = new $parent_bean_name();
  77             $this->parent_bean->retrieve($this->parent_record_id);
  78             $result = $this->parent_bean;
  79                 }
  80
  81                 if($record_id!='fab4' && $result == null)
  82                 {
  83                         sugar_die($app_strings['ERROR_NO_RECORD']);
  84                 }
  85
  86                 if (empty($subpanelDef)) {
  87                         //load the subpanel by name.
  88                         if (!class_exists('MyClass')) {
  89                                 require_once 'include/SubPanel/SubPanelDefinitions.php' ;
  90                         }
  91                         $panelsdef=new SubPanelDefinitions($result,$layout_def_key);
  92                         $subpanelDef=$panelsdef->load_subpanel($subpanel_id);
  93                         $this->subpanel_defs=$subpanelDef;
  94
  95                 }
  96
  97         }
  98
  99         function setTemplateFile($template_file)
 100         {
 101                 $this->template_file = $template_file;
 102         }
 103
 104         function setBeanList(&$value){
 105                 $this->bean_list =$value;
 106         }
 107
 108         function setHideNewButton($value){
 109                 $this->hideNewButton = $value;
 110         }
 111
 112
 113         function getHeaderText( $currentModule){
 114         }
 115
 116         function get_buttons( $panel_query=null)
 117         {
 118
 119                 $thisPanel =& $this->subpanel_defs;
 120                 $subpanel_def = $thisPanel->get_buttons();
 121
 122                 if(!isset($this->listview)){
 123                         $this->listview = new ListView();
 124                 }
 125                 $layout_manager = $this->listview->getLayoutManager();
 126                 $widget_contents = '<div><table cellpadding="0" cellspacing="0"><tr>';
 127                 foreach($subpanel_def as $widget_data)
 128                 {
 129                         $widget_data['action'] = $_REQUEST['action'];
 130                         $widget_data['module'] =  $thisPanel->get_inst_prop_value('module');
 131                         $widget_data['focus'] = $this->parent_bean;
 132                         $widget_data['subpanel_definition'] = $thisPanel;
 133                         $widget_contents .= '<td style="padding-right: 2px; padding-bottom: 2px;">' . "\n";
 134
 135                         if(empty($widget_data['widget_class']))
 136                         {
 137                                 $widget_contents .= "widget_class not defined for top subpanel buttons";
 138                         }
 139                         else
 140                         {
 141                                 $widget_contents .= $layout_manager->widgetDisplay($widget_data);
 142                         }
 143
 144                         $widget_contents .= '</td>';
 145                 }
 146
 147                 $widget_contents .= '</tr></table></div>';
 148                 return $widget_contents;
 149         }
 150
 151
 152         function ProcessSubPanelListView($xTemplatePath, &$mod_strings)
 153         {
 154                 global $app_strings;
 155                 global $current_user;
 156                 global $sugar_config;
 157
 158                 if(isset($this->listview)){
 159                         $ListView =& $this->listview;
 160                 }else{
 161                         $ListView = new ListView();
 162                 }
 163                 $ListView->initNewXTemplate($xTemplatePath,$this->subpanel_defs->mod_strings);
 164                 $ListView->xTemplateAssign("RETURN_URL", "&return_module=".$this->parent_module."&return_action=DetailView&return_id=".$this->parent_bean->id);
 165                 $ListView->xTemplateAssign("RELATED_MODULE", $this->parent_module);  // TODO: what about unions?
 166                 $ListView->xTemplateAssign("RECORD_ID", $this->parent_bean->id);
 167                 $ListView->xTemplateAssign("EDIT_INLINE_PNG", SugarThemeRegistry::current()->getImage('edit_inline','align="absmiddle"  border="0"',null,null,'.gif',$app_strings['LNK_EDIT']));
 168                 $ListView->xTemplateAssign("DELETE_INLINE_PNG", SugarThemeRegistry::current()->getImage('delete_inline','align="absmiddle" border="0"',null,null,'.gif',$app_strings['LBL_DELETE_INLINE']));
 169                 $ListView->xTemplateAssign("REMOVE_INLINE_PNG", SugarThemeRegistry::current()->getImage('delete_inline','align="absmiddle" border="0"',null,null,'.gif',$app_strings['LBL_ID_FF_REMOVE']));
 170                 $header_text= '';
 171
 172                 if(is_admin($current_user) && $_REQUEST['module'] != 'DynamicLayout' && !empty($_SESSION['editinplace']))
 173                 {
 174                         $exploded = explode('/', $xTemplatePath);
 175                         $file_name = $exploded[sizeof($exploded) - 1];
 176                         $mod_name =  $exploded[sizeof($exploded) - 2];
 177                         $header_text= "&nbsp;<a href='index.php?action=index&module=DynamicLayout&from_action=$file_name&from_module=$mod_name&mod_lang="
 178                                 .$_REQUEST['module']."'>".SugarThemeRegistry::current()->getImage("EditLayout","border='0' align='bottom'",null,null,'.gif','Edit Layout')."</a>";
 179                 }
 180                 $ListView->setHeaderTitle('');
 181                 $ListView->setHeaderText('');
 182
 183                 ob_start();
 184
 185                 $ListView->is_dynamic = true;
 186                 $ListView->records_per_page = $sugar_config['list_max_entries_per_subpanel'] + 0;
 187                 $ListView->start_link_wrapper = "javascript:showSubPanel('".$this->subpanel_id."','";
 188                 $ListView->subpanel_id = $this->subpanel_id;
 189                 $ListView->end_link_wrapper = "',true);";
 190         if ( !empty($this->layout_def_key) ) {
 191             $ListView->end_link_wrapper = '&layout_def_key='.$this->layout_def_key.$ListView->end_link_wrapper;
 192         }
 193
 194                 $where = '';
 195                 $ListView->setQuery($where, '', '', '');
 196                 $ListView->show_export_button = false;
 197
 198                 //function returns the query that was used to populate sub-panel data.
 199
 200                 $query=$ListView->process_dynamic_listview($this->parent_module, $this->parent_bean,$this->subpanel_defs);
 201         $this->subpanel_query=$query;
 202                 $ob_contents = ob_get_contents();
 203                 ob_end_clean();
 204                 return $ob_contents;
 205         }
 206
 207         function display()
 208         {
 209                 global $timedate;
 210                 global $mod_strings;
 211                 global $app_strings;
 212                 global $app_list_strings;
 213                 global $beanList;
 214                 global $beanFiles;
 215                 global $current_language;
 216
 217                 $result_array = array();
 218
 219                 $return_string = $this->ProcessSubPanelListView($this->template_file,$result_array);
 220
 221                 print $return_string;
 222         }
 223
 224         function getModulesWithSubpanels()
 225         {
 226                 global $beanList;
 227                 $dir = dir('modules');
 228                 $modules = array();
 229                 while($entry = $dir->read())
 230                 {
 231                         if(file_exists('modules/' . $entry . '/layout_defs.php'))
 232                         {
 233                                 $modules[$entry] = $entry;
 234                         }
 235                 }
 236                 return $modules;
 237         }
 238
 239   function getModuleSubpanels($module){
 240         require_once('include/SubPanel/SubPanelDefinitions.php');
 241                 global $beanList, $beanFiles;
 242                 if(!isset($beanList[$module])){
 243                         return array();
 244                 }
 245
 246                 $class = $beanList[$module];
 247                 require_once($beanFiles[$class]);
 248                 $mod = new $class();
 249                 $spd = new SubPanelDefinitions($mod);
 250                 $tabs = $spd->get_available_tabs(true);
 251                 $ret_tabs = array();
 252                 $reject_tabs = array('history'=>1, 'activities'=>1);
 253                 foreach($tabs as $key=>$tab){
 254                     foreach($tab as $k=>$v){
 255                 if (! isset ( $reject_tabs [$k] )) {
 256                     $ret_tabs [$k] = $v;
 257                 }
 258             }
 259                 }
 260
 261                 return $ret_tabs;
 262
 263
 264   }
 265
 266   //saves overrides for defs
 267   function saveSubPanelDefOverride( $panel, $subsection, $override){
 268                 global $layout_defs, $beanList;
 269
 270                 //save the new subpanel
 271                 $name = "subpanel_layout['list_fields']";
 272
 273                 //bugfix: load looks for moduleName/metadata/subpanels, not moduleName/subpanels
 274                 $path = 'custom/modules/'. $panel->_instance_properties['module'] . '/metadata/subpanels';
 275
 276                 //bug# 40171: "Custom subpanels not working as expected"
 277                 //each custom subpanel needs to have a unique custom def file
 278                 $filename = $panel->parent_bean->object_name . "_subpanel_" . $panel->name; //bug 42262 (filename with $panel->_instance_properties['get_subpanel_data'] can create problem if had word "function" in it)
 279                 $oldName1 = '_override' . $panel->parent_bean->object_name .$panel->_instance_properties['module'] . $panel->_instance_properties['subpanel_name'] ;
 280                 $oldName2 = '_override' . $panel->parent_bean->object_name .$panel->_instance_properties['get_subpanel_data'] ;
 281                 if (file_exists('custom/Extension/modules/'. $panel->parent_bean->module_dir . "/Ext/Layoutdefs/$oldName1.php")){
 282                   unlink('custom/Extension/modules/'. $panel->parent_bean->module_dir . "/Ext/Layoutdefs/$oldName1.php");
 283                 }
 284                 if (file_exists('custom/Extension/modules/'. $panel->parent_bean->module_dir . "/Ext/Layoutdefs/$oldName2.php")){
 285          unlink('custom/Extension/modules/'. $panel->parent_bean->module_dir . "/Ext/Layoutdefs/$oldName2.php");
 286                 }
 287                 $extname = '_override'.$filename;
 288                 //end of bug# 40171
 289
 290                 mkdir_recursive($path, true);
 291                 write_array_to_file( $name, $override,$path.'/' . $filename .'.php');
 292
 293                 //save the override for the layoutdef
 294         //tyoung 10.12.07 pushed panel->name to lowercase to match case in subpaneldefs.php files -
 295         //gave error on bad index 'module' as this override key didn't match the key in the subpaneldefs
 296                 $name = "layout_defs['".  $panel->parent_bean->module_dir. "']['subpanel_setup']['" .strtolower($panel->name). "']";
 297 //      $GLOBALS['log']->debug('SubPanel.php->saveSubPanelDefOverride(): '.$name);
 298                 $newValue = override_value_to_string($name, 'override_subpanel_name', $filename);
 299                 mkdir_recursive('custom/Extension/modules/'. $panel->parent_bean->module_dir . '/Ext/Layoutdefs', true);
 300                 $fp = sugar_fopen('custom/Extension/modules/'. $panel->parent_bean->module_dir . "/Ext/Layoutdefs/$extname.php", 'w');
 301                 fwrite($fp, "<?php\n//auto-generated file DO NOT EDIT\n$newValue\n?>");
 302                 fclose($fp);
 303                 require_once('ModuleInstall/ModuleInstaller.php');
 304                 $moduleInstaller = new ModuleInstaller();
 305                 $moduleInstaller->silent = true; // make sure that the ModuleInstaller->log() function doesn't echo while rebuilding the layoutdefs
 306                 $moduleInstaller->rebuild_layoutdefs();
 307                 if (file_exists('modules/'.  $panel->parent_bean->module_dir . '/layout_defs.php'))
 308                         include('modules/'.  $panel->parent_bean->module_dir . '/layout_defs.php');
 309                 if (file_exists('custom/modules/'.  $panel->parent_bean->module_dir . '/Ext/Layoutdefs/layoutdefs.ext.php'))
 310                         include('custom/modules/'.  $panel->parent_bean->module_dir . '/Ext/Layoutdefs/layoutdefs.ext.php');
 311   }
 312
 313         function get_subpanel_setup($module)
 314         {
 315                 $subpanel_setup = '';
 316                 $layout_defs = get_layout_defs();
 317
 318                 if(!empty($layout_defs) && !empty($layout_defs[$module]['subpanel_setup']))
 319       {
 320         $subpanel_setup = $layout_defs[$module]['subpanel_setup'];
 321       }
 322
 323       return $subpanel_setup;
 324         }
 325
 326         /**
 327          * Retrieve the subpanel definition from the registered layout_defs arrays.
 328          */
 329         function getSubPanelDefine($module, $subpanel_id)
 330         {
 331                 $default_subpanel_define = SubPanel::_get_default_subpanel_define($module, $subpanel_id);
 332                 $custom_subpanel_define = SubPanel::_get_custom_subpanel_define($module, $subpanel_id);
 333
 334                 $subpanel_define = array_merge($default_subpanel_define, $custom_subpanel_define);
 335
 336                 if(empty($subpanel_define))
 337                 {
 338                         print('Could not load subpanel definition for: ' . $subpanel_id);
 339                 }
 340
 341                 return $subpanel_define;
 342         }
 343
 344         function _get_custom_subpanel_define($module, $subpanel_id)
 345         {
 346                 $ret_val = array();
 347
 348                 if($subpanel_id != '')
 349                 {
 350                         $layout_defs = get_layout_defs();
 351
 352                         if(!empty($layout_defs[$module]['custom_subpanel_defines'][$subpanel_id]))
 353                         {
 354                                 $ret_val = $layout_defs[$module]['custom_subpanel_defines'][$subpanel_id];
 355                         }
 356                 }
 357
 358                 return $ret_val;
 359         }
 360
 361         function _get_default_subpanel_define($module, $subpanel_id)
 362         {
 363                 $ret_val = array();
 364
 365                 if($subpanel_id != '')
 366                 {
 367                         $layout_defs = get_layout_defs();
 368
 369                         if(!empty($layout_defs[$subpanel_id]['default_subpanel_define']))
 370                         {
 371                                 $ret_val = $layout_defs[$subpanel_id]['default_subpanel_define'];
 372                         }
 373                 }
 374
 375                 return $ret_val;
 376         }
 377 }
 378 ?>