]> CyberLeo.Net >> Repos - Github/sugarcrm.git/blob - include/SubPanel/SubPanelTiles.php
Release 6.5.6
[Github/sugarcrm.git] / include / SubPanel / SubPanelTiles.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
39 require_once('include/SubPanel/SubPanel.php');
40 require_once('include/SubPanel/SubPanelTilesTabs.php');
41 require_once('include/SubPanel/SubPanelDefinitions.php');
42
43 /**
44  * Subpanel tiles
45  * @api
46  */
47 class SubPanelTiles
48 {
49         var $id;
50         var $module;
51         var $focus;
52         var $start_on_field;
53         var $layout_manager;
54         var $layout_def_key;
55         var $show_tabs = false;
56
57         var $subpanel_definitions;
58
59         var $hidden_tabs=array(); //consumer of this class can array of tabs that should be hidden. the tab name
60                                                         //should be the array.
61
62         function SubPanelTiles(&$focus, $layout_def_key='', $layout_def_override = '')
63         {
64                 $this->focus = $focus;
65                 $this->id = $focus->id;
66                 $this->module = $focus->module_dir;
67                 $this->layout_def_key = $layout_def_key;
68                 $this->subpanel_definitions=new SubPanelDefinitions($focus, $layout_def_key, $layout_def_override);
69         }
70
71         /*
72          * Return the current selected or requested subpanel tab
73          * @return      string  The identifier for the selected subpanel tab (e.g., 'Other')
74          */
75     function getSelectedGroup()
76     {
77         global $current_user;
78
79         if(isset($_REQUEST['subpanelTabs']))
80             $_SESSION['subpanelTabs'] = $_REQUEST['subpanelTabs'];
81
82         require_once 'include/tabConfig.php' ; // include/tabConfig.php in turn includes the customized file at custom/include/tabConfig.php...
83
84         $subpanelTabsPref = $current_user->getPreference('subpanel_tabs');
85         if(!isset($subpanelTabsPref)) $subpanelTabsPref = $GLOBALS['sugar_config']['default_subpanel_tabs'];
86         if(!empty($GLOBALS['tabStructure']) && (!empty($_SESSION['subpanelTabs']) || !empty($sugar_config['subpanelTabs']) || !empty($subpanelTabsPref)))
87         {
88             // Determine selected group
89             if(!empty($_REQUEST['subpanel']))
90             {
91                 $selected_group = $_REQUEST['subpanel'];
92             }
93             elseif(!empty($_COOKIE[$this->module.'_sp_tab']))
94             {
95                 $selected_group = $_COOKIE[$this->module.'_sp_tab'];
96             }
97             elseif(!empty($_SESSION['parentTab']) && !empty($GLOBALS['tabStructure'][$_SESSION['parentTab']]) && in_array($this->module, $GLOBALS['tabStructure'][$_SESSION['parentTab']]['modules']))
98             {
99                 $selected_group = $_SESSION['parentTab'];
100             }
101             else
102             {
103                 $selected_group = '';
104                 foreach($GLOBALS['tabStructure'] as $mainTab => $group)
105                 {
106                     if(in_array($this->module, $group['modules']))
107                     {
108                         $selected_group = $mainTab;
109                         break;
110                     }
111                 }
112                 if(!$selected_group)
113                 {
114                     $selected_group = 'All';
115                 }
116             }
117         }
118         else
119         {
120                 $selected_group = '';
121         }
122         return $selected_group;
123     }
124
125     /*
126      * Determine which subpanels should be shown within the selected tab group (e.g., 'Other');
127      * @param boolean $showTabs         True if we should call the code to render each visible tab
128      * @param string $selectedGroup     The requested tab group
129      * @return array Visible tabs
130      */
131     function getTabs($showTabs = true, $selectedGroup='')
132     {
133         global $current_user;
134
135         //get all the "tabs" - this actually means all the subpanels available for display within a tab
136         $tabs = $this->subpanel_definitions->get_available_tabs();
137
138         if(!empty($selectedGroup))
139         {
140             // Bug #44344 : Custom relationships under same module only show once in subpanel tabs
141             // use object property instead new object to have ability run unit test (can override subpanel_definitions)
142             $objSubPanelTilesTabs = new SubPanelTilesTabs($this->focus);
143             $tabs = $objSubPanelTilesTabs->getTabs($tabs, $showTabs, $selectedGroup);
144             unset($objSubPanelTilesTabs);
145             return $tabs;
146             }
147         else
148         {
149             // see if user current user has custom subpanel layout
150             $tabs = SubPanelTilesTabs::applyUserCustomLayoutToTabs($tabs);
151
152             /* Check if the preference is set now,
153              * because there's no point in executing this code if
154              * we aren't going to render anything.
155              */
156             $subpanelLinksPref = $current_user->getPreference('subpanel_links');
157             if(!isset($subpanelLinksPref)) $subpanelLinksPref = $GLOBALS['sugar_config']['default_subpanel_links'];
158
159             if($showTabs && $subpanelLinksPref){
160                require_once('include/SubPanel/SugarTab.php');
161                $sugarTab = new SugarTab();
162
163                $displayTabs = array();
164
165                foreach($tabs as $tab){
166                    $displayTabs []= array('key'=>$tab, 'label'=>translate($this->subpanel_definitions->layout_defs['subpanel_setup'][$tab]['title_key']));
167                    //echo '<td nowrap="nowrap"><a class="subTabLink" href="#' . $tab . '">' .  translate($this->subpanel_definitions->layout_defs['subpanel_setup'][$tab]['title_key']) .  '</a></td><td> | </td>';
168                }
169                $sugarTab->setup(array(),array(),$displayTabs);
170                $sugarTab->display();
171             }
172             //echo '<td width="100%">&nbsp;</td></tr></table>';
173         }
174             return $tabs;
175
176         }
177         function display($showContainer = true, $forceTabless = false)
178         {
179                 global $layout_edit_mode, $sugar_version, $sugar_config, $current_user, $app_strings;
180                 if(isset($layout_edit_mode) && $layout_edit_mode){
181                         return;
182                 }
183
184                 global $modListHeader;
185
186                 ob_start();
187     echo '<script type="text/javascript" src="'. getJSPath('include/SubPanel/SubPanelTiles.js') . '"></script>';
188 ?>
189 <script>
190 if(document.DetailView != null &&
191    document.DetailView.elements != null &&
192    document.DetailView.elements.layout_def_key != null &&
193    typeof document.DetailView.elements['layout_def_key'] != 'undefined'){
194     document.DetailView.elements['layout_def_key'].value = '<?php echo $this->layout_def_key; ?>';
195 }
196 </script>
197 <?php
198
199                 $tabs = array();
200                 $default_div_display = 'inline';
201                 if(!empty($sugar_config['hide_subpanels_on_login'])){
202                         if(!isset($_SESSION['visited_details'][$this->focus->module_dir])){
203                                 setcookie($this->focus->module_dir . '_divs', '');
204                                 unset($_COOKIE[$this->focus->module_dir . '_divs']);
205                                 $_SESSION['visited_details'][$this->focus->module_dir] = true;
206
207                         }
208                         $default_div_display = 'none';
209                 }
210                 $div_cookies = get_sub_cookies($this->focus->module_dir . '_divs');
211
212
213                 //Display the group header. this section is executed only if the tabbed interface is being used.
214                 $current_key = '';
215                 if (! empty($this->show_tabs))
216                 {
217                         require_once('include/tabs.php');
218                 $tab_panel = new SugarWidgetTabs($tabs, $current_key, 'showSubPanel');
219                         echo get_form_header('Related', '', false);
220                         echo "<br />" . $tab_panel->display();
221                 }
222
223         if(empty($_REQUEST['subpanels']))
224         {
225             $selected_group = $forceTabless?'':$this->getSelectedGroup();
226             $usersLayout = $current_user->getPreference('subpanelLayout', $this->focus->module_dir);
227
228             // we need to use some intelligence here when restoring the user's layout, as new modules with new subpanels might have been installed since the user's layout was recorded
229             // this means that we can't just restore the old layout verbatim as the new subpanels would then go walkabout
230             // so we need to do a merge while attempting as best we can to preserve the sense of the specified order
231             // this is complicated by the different ordering schemes used in the two sources for the panels: the user's layout uses an ordinal layout, the panels from getTabs have an explicit ordering driven by the 'order' parameter
232             // it's not clear how to best reconcile these two schemes; so we punt on it, and add all new panels to the end of the user's layout. At least this will give them a clue that something has changed...
233             // we also now check for tabs that have been removed since the user saved his or her preferences.
234
235             $tabs = $this->getTabs($showContainer, $selected_group) ;
236
237             if(!empty($usersLayout))
238             {
239                 $availableTabs = $tabs ;
240                 $tabs = array_intersect ( $usersLayout , $availableTabs ) ; // remove any tabs that have been removed since the user's layout was saved
241                 foreach (array_diff ( $availableTabs , $usersLayout ) as $tab)
242                     $tabs [] = $tab ;
243             }
244         }
245         else
246         {
247                 $tabs = explode(',', $_REQUEST['subpanels']);
248         }
249
250         $tab_names = array();
251
252         if($showContainer)
253         {
254             echo '<ul class="noBullet" id="subpanel_list">';
255         }
256         //echo "<li id='hidden_0' style='height: 5px' class='noBullet'>&nbsp;&nbsp;&nbsp;</li>";
257         if (empty($GLOBALS['relationships'])) {
258                 if (!class_exists('Relationship')) {
259                         require('modules/Relationships/Relationship.php');
260                 }
261                 $rel= new Relationship();
262                 $rel->load_relationship_meta();
263         }
264
265         foreach ($tabs as $tab)
266                 {
267                         //load meta definition of the sub-panel.
268                         $thisPanel=$this->subpanel_definitions->load_subpanel($tab);
269             if ($thisPanel === false)
270                 continue;
271                         //this if-block will try to skip over ophaned subpanels. Studio/MB are being delete unloaded modules completely.
272                         //this check will ignore subpanels that are collections (activities, history, etc)
273                         if (!isset($thisPanel->_instance_properties['collection_list']) and isset($thisPanel->_instance_properties['get_subpanel_data']) ) {
274                                 //ignore when data source is a function
275
276                                 if (!isset($this->focus->field_defs[$thisPanel->_instance_properties['get_subpanel_data']])) {
277                                         if (stripos($thisPanel->_instance_properties['get_subpanel_data'],'function:') === false) {
278                                                 $GLOBALS['log']->fatal("Bad subpanel definition, it has incorrect value for get_subpanel_data property " .$tab);
279                                                 continue;
280                                         }
281                                 } else {
282                                         $rel_name='';
283                                         if (isset($this->focus->field_defs[$thisPanel->_instance_properties['get_subpanel_data']]['relationship'])) {
284                                                 $rel_name=$this->focus->field_defs[$thisPanel->_instance_properties['get_subpanel_data']]['relationship'];
285                                         }
286
287                                         if (empty($rel_name) or !isset($GLOBALS['relationships'][$rel_name])) {
288                                                 $GLOBALS['log']->fatal("Missing relationship definition " .$rel_name. ". skipping " .$tab ." subpanel");
289                                                 continue;
290                                         }
291                                 }
292                         }
293
294                         echo '<li class="noBullet" id="whole_subpanel_' . $tab . '">';
295
296                         $display= 'none';
297                         $div_display = $default_div_display;
298                         $cookie_name =   $tab . '_v';
299
300                         if (isset($thisPanel->_instance_properties['collapsed']) && $thisPanel->_instance_properties['collapsed'])
301                         {
302                                 $div_display = 'none';
303                         }
304                                 
305                         if(isset($div_cookies[$cookie_name])){
306                                 //If defaultSubPanelExpandCollapse is set, ignore the cookie that remembers whether the panel is expanded or collapsed.
307                                 //To be used with the above 'collapsed' metadata setting so they will always be set the same when the page is loaded.
308                                 if(!isset($sugar_config['defaultSubPanelExpandCollapse']) || $sugar_config['defaultSubPanelExpandCollapse'] == false)
309                                         $div_display =  $div_cookies[$cookie_name];
310                         }
311                         if(!empty($sugar_config['hide_subpanels'])){
312                                 $div_display = 'none';
313                         }
314             if($thisPanel->isDefaultHidden()) {
315                 $div_display = 'none';
316             }
317                         if($div_display == 'none'){
318                                 $opp_display  = 'inline';
319                         }else{
320                                 $opp_display  = 'none';
321                         }
322
323             if (!empty($this->layout_def_key) ) {
324                 $layout_def_key = $this->layout_def_key;
325             } else {
326                 $layout_def_key = '';
327             }
328
329                         if (empty($this->show_tabs))
330                         {
331                                 $show_icon_html = SugarThemeRegistry::current()->getImage( 'advanced_search', 'border="0" align="absmiddle"',null,null,'.gif',translate('LBL_SHOW'));
332                                 $hide_icon_html = SugarThemeRegistry::current()->getImage( 'basic_search', 'border="0" align="absmiddle"',null,null,'.gif',translate('LBL_HIDE'));
333
334                                 $max_min = "<a name=\"$tab\"> </a><span id=\"show_link_".$tab."\" style=\"display: $opp_display\"><a href='#' class='utilsLink' onclick=\"current_child_field = '".$tab."';showSubPanel('".$tab."',null,null,'".$layout_def_key."');document.getElementById('show_link_".$tab."').style.display='none';document.getElementById('hide_link_".$tab."').style.display='';return false;\">"
335                                         . "" . $show_icon_html . "</a></span>";
336                                 $max_min .= "<span id=\"hide_link_".$tab."\" style=\"display: $div_display\"><a href='#' class='utilsLink' onclick=\"hideSubPanel('".$tab."');document.getElementById('hide_link_".$tab."').style.display='none';document.getElementById('show_link_".$tab."').style.display='';return false;\">"
337                                  . "" . $hide_icon_html . "</a></span>";
338                                 echo '<div id="subpanel_title_' . $tab . '"';
339                 if(empty($sugar_config['lock_subpanels']) || $sugar_config['lock_subpanels'] == false) echo ' onmouseover="this.style.cursor = \'move\';"';
340                 echo '>' . get_form_header( $thisPanel->get_title(), $max_min, false) . '</div>';
341                         }
342
343             echo <<<EOQ
344 <div cookie_name="$cookie_name" id="subpanel_$tab" style="display:$div_display">
345     <script>document.getElementById("subpanel_$tab" ).cookie_name="$cookie_name";</script>
346 EOQ;
347             $display_spd = '';
348             if($div_display != 'none'){
349                 echo "<script>SUGAR.util.doWhen(\"typeof(markSubPanelLoaded) != 'undefined'\", function() {markSubPanelLoaded('$tab');});</script>";
350                 $old_contents = ob_get_contents();
351                 @ob_end_clean();
352
353                 ob_start();
354                 include_once('include/SubPanel/SubPanel.php');
355                 $subpanel_object = new SubPanel($this->module, $_REQUEST['record'], $tab,$thisPanel,$layout_def_key);
356                 $subpanel_object->setTemplateFile('include/SubPanel/SubPanelDynamic.html');
357                 $subpanel_object->display();
358                 $subpanel_data = ob_get_contents();
359                 @ob_end_clean();
360
361                 ob_start();
362                 echo $this->get_buttons($thisPanel,$subpanel_object->subpanel_query);
363                 $buttons = ob_get_contents();
364                 @ob_end_clean();
365
366                 ob_start();
367                 echo $old_contents;
368                 //echo $buttons;
369                 $display_spd = $subpanel_data;
370             }
371             echo <<<EOQ
372     <div id="list_subpanel_$tab">$display_spd</div>
373 </div>
374 EOQ;
375                 array_push($tab_names, $tab);
376                 echo '</li>';
377         } // end $tabs foreach
378         if($showContainer)
379         {
380                 echo '</ul>';
381
382
383             if(!empty($selected_group))
384             {
385                 // closing table from tpls/singletabmenu.tpl
386                 echo '</td></tr></table>';
387             }
388         }
389         // drag/drop code
390         $tab_names = '["' . join($tab_names, '","') . '"]';
391         global $sugar_config;
392
393         if(empty($sugar_config['lock_subpanels']) || $sugar_config['lock_subpanels'] == false) {
394             echo <<<EOQ
395     <script>
396         var SubpanelInit = function() {
397                 SubpanelInitTabNames({$tab_names});
398         }
399         var SubpanelInitTabNames = function(tabNames) {
400                 subpanel_dd = new Array();
401                 j = 0;
402                 for(i in tabNames) {
403                         subpanel_dd[j] = new ygDDList('whole_subpanel_' + tabNames[i]);
404                         subpanel_dd[j].setHandleElId('subpanel_title_' + tabNames[i]);
405                         subpanel_dd[j].onMouseDown = SUGAR.subpanelUtils.onDrag;
406                         subpanel_dd[j].afterEndDrag = SUGAR.subpanelUtils.onDrop;
407                         j++;
408                 }
409
410                 YAHOO.util.DDM.mode = 1;
411         }
412         currentModule = '{$this->module}';
413         SUGAR.util.doWhen(
414             "typeof(SUGAR.subpanelUtils) == 'object' && typeof(SUGAR.subpanelUtils.onDrag) == 'function'" +
415                 " && document.getElementById('subpanel_list')",
416             SubpanelInit
417         );
418     </script>
419 EOQ;
420         }
421
422                 $ob_contents = ob_get_contents();
423                 ob_end_clean();
424                 return $ob_contents;
425         }
426
427
428         function getLayoutManager()
429         {
430                 require_once('include/generic/LayoutManager.php');
431                 if ( $this->layout_manager == null) {
432                 $this->layout_manager = new LayoutManager();
433                 }
434                 return $this->layout_manager;
435         }
436
437         function get_buttons($thisPanel,$panel_query=null)
438         {
439                 $subpanel_def = $thisPanel->get_buttons();
440         $layout_manager = $this->getLayoutManager();
441
442         //for action button at the top of each subpanel
443         // bug#51275: smarty widget to help provide the action menu functionality as it is currently sprinkled throughout the app with html
444         $buttons = array();
445         $widget_contents = '';
446                 foreach($subpanel_def as $widget_data)
447                 {
448
449                         $widget_data['action'] = $_REQUEST['action'];
450                         $widget_data['module'] =  $thisPanel->get_inst_prop_value('module');
451                         $widget_data['focus'] = $this->focus;
452                         $widget_data['subpanel_definition'] = $thisPanel;
453                         $widget_contents .= '<td class="buttons">' . "\n";
454
455                         if(empty($widget_data['widget_class']))
456                         {
457                                 $buttons[] = "widget_class not defined for top subpanel buttons";
458                         }
459                         else
460                         {
461                                 $buttons[] = $layout_manager->widgetDisplay($widget_data);
462                         }
463
464         }
465         require_once('include/Smarty/plugins/function.sugar_action_menu.php');
466         $widget_contents = smarty_function_sugar_action_menu(array(
467             'buttons' => $buttons,
468             'class' => 'clickMenu fancymenu',
469         ), $this->xTemplate);
470         return $widget_contents;
471         }
472 }
473 ?>