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-2011 SugarCRM Inc.
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.
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
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
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.
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.
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 ********************************************************************************/
38 require_once('include/ListView/ListViewSmarty.php');
40 require_once('include/TemplateHandler/TemplateHandler.php');
41 require_once('include/SearchForm/SearchForm2.php');
42 define("NUM_COLS", 2);
43 class PopupSmarty extends ListViewSmarty{
45 var $contextMenus = false;
47 var $mailmerge = false;
48 var $mergeduplicates = false;
49 var $quickViewLinks = false;
50 var $multiSelect = false;
60 var $searchdefs = array();
61 var $listviewdefs = array();
62 var $searchFields = array();
64 var $filter_fields = array();
68 var $massUpdateData = '';
70 function PopupSmarty($seed, $module){
71 parent::ListViewSmarty();
72 $this->th = new TemplateHandler();
73 $this->th->loadSmarty();
75 $this->view = 'Popup';
76 $this->module = $module;
77 $this->searchForm = new SearchForm($this->seed, $this->module);
78 $this->th->deleteTemplate($module, $this->view);
84 * Assign several arrow image attributes to TemplateHandler smarty. Such as width, height, etc.
88 function processArrowVars()
90 $pathParts = pathinfo(SugarThemeRegistry::current()->getImageURL('arrow.gif',false));
92 list($width,$height) = getimagesize($pathParts['dirname'].'/'.$pathParts['basename']);
94 $this->th->ss->assign('arrowExt', $pathParts['extension']);
95 $this->th->ss->assign('arrowWidth', $width);
96 $this->th->ss->assign('arrowHeight', $height);
97 $this->th->ss->assign('arrowAlt', translate('LBL_SORT'));
101 * Processes the request. Calls ListViewData process. Also assigns all lang strings, export links,
102 * This is called from ListViewDisplay
104 * @param file file Template file to use
105 * @param data array from ListViewData
106 * @param html_var string the corresponding html var in xtpl per row
109 function process($file, $data, $htmlVar) {
111 global $odd_bg, $even_bg, $hilite_bg, $click_bg, $app_strings;
112 parent::process($file, $data, $htmlVar);
118 foreach($this->displayColumns as $name => $params) {
119 $totalWidth += $params['width'];
121 $adjustment = $totalWidth / 100;
123 $contextMenuObjectsTypes = array();
124 foreach($this->displayColumns as $name => $params) {
125 $this->displayColumns[$name]['width'] = round($this->displayColumns[$name]['width'] / $adjustment, 2);
126 // figure out which contextMenu objectsTypes are required
127 if(!empty($params['contextMenu']['objectType']))
128 $contextMenuObjectsTypes[$params['contextMenu']['objectType']] = true;
130 $this->th->ss->assign('displayColumns', $this->displayColumns);
133 $this->th->ss->assign('bgHilite', $hilite_bg);
134 $this->th->ss->assign('colCount', count($this->displayColumns) + 1);
135 $this->th->ss->assign('htmlVar', strtoupper($htmlVar));
136 $this->th->ss->assign('moduleString', $this->moduleString);
137 $this->th->ss->assign('editLinkString', $GLOBALS['app_strings']['LBL_EDIT_BUTTON']);
138 $this->th->ss->assign('viewLinkString', $GLOBALS['app_strings']['LBL_VIEW_BUTTON']);
141 $this->searchForm->parsedView = 'popup_query_form';
142 $this->searchForm->displayType = 'popupView';
143 $this->th->ss->assign('searchForm', $this->searchForm->display(false));
146 if($this->overlib) $this->th->ss->assign('overlib', true);
147 if($this->export) $this->th->ss->assign('exportLink', $this->buildExportLink());
148 $this->th->ss->assign('quickViewLinks', $this->quickViewLinks);
149 if($this->mailMerge) $this->th->ss->assign('mergeLink', $this->buildMergeLink()); // still check for mailmerge access
150 if($this->mergeduplicates) $this->th->ss->assign('mergedupLink', $this->buildMergeDuplicatesLink());
153 if (!empty($_REQUEST['mode']) && strtoupper($_REQUEST['mode']) == 'MULTISELECT') {
154 $this->multiSelect = true;
156 // handle save checks and stuff
157 if($this->multiSelect) {
158 $this->th->ss->assign('selectedObjectsSpan', $this->buildSelectedObjectsSpan());
159 $this->th->ss->assign('multiSelectData', $this->getMultiSelectData());
160 $this->th->ss->assign('MODE', "<input type='hidden' name='mode' value='MultiSelect'>");
161 $pageTotal = $this->data['pageData']['offsets']['next'] - $this->data['pageData']['offsets']['current'];
162 if($this->data['pageData']['offsets']['next'] < 0){ // If we are on the last page, 'next' is -1, which means we have to have a custom calculation
163 $pageTotal = $this->data['pageData']['offsets']['total'] - $this->data['pageData']['offsets']['current'];
165 $this->th->ss->assign('selectLink', $this->buildSelectLink('select_link', $this->data['pageData']['offsets']['total'], $pageTotal));
168 $this->processArrows($data['pageData']['ordering']);
169 $this->th->ss->assign('prerow', $this->multiSelect);
170 $this->th->ss->assign('rowColor', array('oddListRow', 'evenListRow'));
171 $this->th->ss->assign('bgColor', array($odd_bg, $even_bg));
172 $this->th->ss->assign('contextMenus', $this->contextMenus);
175 if($this->contextMenus && !empty($contextMenuObjectsTypes)) {
177 $cm = new contextMenu();
178 foreach($contextMenuObjectsTypes as $type => $value) {
179 $cm->loadFromFile($type);
180 $script .= $cm->getScript();
181 $cm->menuItems = array(); // clear menuItems out
183 $this->th->ss->assign('contextMenuScript', $script);
187 $this->_build_field_defs();
189 // arrow image attributes
190 $this->processArrowVars();
194 * Display the Smarty template. Here we are using the TemplateHandler for caching per the module.
196 function display($end = true) {
199 if(!is_file($GLOBALS['sugar_config']['cache_dir'] . 'jsLanguage/' . $GLOBALS['current_language'] . '.js')) {
200 require_once('include/language/jsLanguage.php');
201 jsLanguage::createAppStringsCache($GLOBALS['current_language']);
203 $jsLang = '<script type="text/javascript" src="' . $GLOBALS['sugar_config']['cache_dir'] . 'jsLanguage/' . $GLOBALS['current_language'] . '.js?s=' . $GLOBALS['sugar_version'] . '&c=' . $GLOBALS['sugar_config']['js_custom_version'] . '&j=' . $GLOBALS['sugar_config']['js_lang_version'] . '"></script>';
205 $this->th->ss->assign('data', $this->data['data']);
206 $this->data['pageData']['offsets']['lastOffsetOnPage'] = $this->data['pageData']['offsets']['current'] + count($this->data['data']);
207 $this->th->ss->assign('pageData', $this->data['pageData']);
209 $navStrings = array('next' => $GLOBALS['app_strings']['LNK_LIST_NEXT'],
210 'previous' => $GLOBALS['app_strings']['LNK_LIST_PREVIOUS'],
211 'end' => $GLOBALS['app_strings']['LNK_LIST_END'],
212 'start' => $GLOBALS['app_strings']['LNK_LIST_START'],
213 'of' => $GLOBALS['app_strings']['LBL_LIST_OF']);
214 $this->th->ss->assign('navStrings', $navStrings);
217 $associated_row_data = array();
219 //C.L. - Bug 44324 - Override the NAME entry to not display salutation so that the data returned from the popup can be searched on correctly
220 $searchNameOverride = !empty($this->seed) && $this->seed instanceof Person && (isset($this->data['data'][0]['FIRST_NAME']) && isset($this->data['data'][0]['LAST_NAME'])) ? true : false;
223 foreach($this->data['data'] as $val)
225 $associated_row_data[$val['ID']] = $val;
226 if($searchNameOverride)
228 $associated_row_data[$val['ID']]['NAME'] = $locale->getLocaleFormattedName($val['FIRST_NAME'], $val['LAST_NAME']);
231 $is_show_fullname = showFullName() ? 1 : 0;
232 $json = getJSONobj();
233 $this->th->ss->assign('jsLang', $jsLang);
234 $this->th->ss->assign('lang', substr($GLOBALS['current_language'], 0, 2));
235 $this->th->ss->assign('headerTpl', 'include/Popups/tpls/header.tpl');
236 $this->th->ss->assign('footerTpl', 'include/Popups/tpls/footer.tpl');
237 $this->th->ss->assign('ASSOCIATED_JAVASCRIPT_DATA', 'var associated_javascript_data = '.$json->encode($associated_row_data). '; var is_show_fullname = '.$is_show_fullname.';');
238 $this->th->ss->assign('module', $this->seed->module_dir);
239 $request_data = empty($_REQUEST['request_data']) ? '' : $_REQUEST['request_data'];
240 $this->th->ss->assign('request_data', $request_data);
241 $this->th->ss->assign('fields', $this->fieldDefs);
242 $this->th->ss->assign('formData', $this->formData);
243 $this->th->ss->assign('APP', $GLOBALS['app_strings']);
244 $this->th->ss->assign('MOD', $GLOBALS['mod_strings']);
245 $this->th->ss->assign('popupMeta', $this->_popupMeta);
246 $this->th->ss->assign('current_query', base64_encode(serialize($_REQUEST)));
247 $this->th->ss->assign('customFields', $this->customFieldDefs);
248 $this->th->ss->assign('numCols', NUM_COLS);
249 $this->th->ss->assign('massUpdateData', $this->massUpdateData);
250 $this->th->ss->assign('jsCustomVersion', $GLOBALS['sugar_config']['js_custom_version']);
251 $this->th->ss->assign('sugarVersion', $GLOBALS['sugar_version']);
252 $this->th->ss->assign('should_process', $this->should_process);
255 $this->th->ss->assign('ADDFORM', $this->getQuickCreate());//$this->_getAddForm());
256 $this->th->ss->assign('ADDFORMHEADER', $this->_getAddFormHeader());
257 $this->th->ss->assign('object_name', $this->seed->object_name);
259 $this->th->ss->assign('LIST_HEADER', get_form_header($GLOBALS['mod_strings']['LBL_LIST_FORM_TITLE'], '', false));
260 $this->th->ss->assign('SEARCH_FORM_HEADER', get_form_header($GLOBALS['mod_strings']['LBL_SEARCH_FORM_TITLE'], '', false));
261 $str = $this->th->displayTemplate($this->seed->module_dir, $this->view, $this->tpl);
266 * Setup up the smarty template. we added an extra step here to add the order by from the popupdefs.
268 function setup($file) {
270 if(isset($this->_popupMeta)){
271 if(isset($this->_popupMeta['create']['formBase'])) {
272 require_once('modules/' . $this->seed->module_dir . '/' . $this->_popupMeta['create']['formBase']);
273 $this->_create = true;
276 if(!empty($this->_popupMeta['create'])){
277 $formBase = new $this->_popupMeta['create']['formBaseClass']();
278 if(isset($_REQUEST['doAction']) && $_REQUEST['doAction'] == 'save')
280 //If it's a new record, set useRequired to false
281 $useRequired = empty($_REQUEST['id']) ? false : true;
282 $formBase->handleSave('', false, $useRequired);
287 if(!empty($this->_popupMeta['orderBy'])){
288 $params['orderBy'] = $this->_popupMeta['orderBy'];
291 if(file_exists('custom/modules/'.$this->module.'/metadata/metafiles.php')){
292 require('custom/modules/'.$this->module.'/metadata/metafiles.php');
293 }elseif(file_exists('modules/'.$this->module.'/metadata/metafiles.php')){
294 require('modules/'.$this->module.'/metadata/metafiles.php');
297 if(!empty($metafiles[$this->module]['searchfields'])) {
298 require($metafiles[$this->module]['searchfields']);
299 } elseif(file_exists('modules/'.$this->module.'/metadata/SearchFields.php')) {
300 require('modules/'.$this->module.'/metadata/SearchFields.php');
302 $this->searchdefs[$this->module]['templateMeta']['maxColumns'] = 2;
303 $this->searchdefs[$this->module]['templateMeta']['widths']['label'] = 10;
304 $this->searchdefs[$this->module]['templateMeta']['widths']['field'] = 30;
306 $this->searchForm->view = 'PopupSearchForm';
307 $this->searchForm->setup($this->searchdefs, $searchFields, 'include/SearchForm/tpls/SearchFormGenericAdvanced.tpl', 'advanced_search', $this->listviewdefs);
309 $lv = new ListViewSmarty();
310 $displayColumns = array();
311 if(!empty($_REQUEST['displayColumns'])) {
312 foreach(explode('|', $_REQUEST['displayColumns']) as $num => $col) {
313 if(!empty($listViewDefs[$this->module][$col]))
314 $displayColumns[$col] = $this->listviewdefs[$this->module][$col];
318 foreach($this->listviewdefs[$this->module] as $col => $para) {
319 if(!empty($para['default']) && $para['default'])
320 $displayColumns[$col] = $para;
323 $params['massupdate'] = true;
324 if(!empty($_REQUEST['orderBy'])) {
325 $params['orderBy'] = $_REQUEST['orderBy'];
326 $params['overrideOrder'] = true;
327 if(!empty($_REQUEST['sortOrder'])) $params['sortOrder'] = $_REQUEST['sortOrder'];
330 $lv->displayColumns = $displayColumns;
331 $this->searchForm->lv = $lv;
332 $this->searchForm->displaySavedSearch = false;
335 $this->searchForm->populateFromRequest('advanced_search');
336 $searchWhere = $this->_get_where_clause();
337 $this->searchColumns = $this->searchForm->searchColumns;
338 //parent::setup($this->seed, $file, $searchWhere, $params, 0, -1, $this->filter_fields);
340 $this->should_process = true;
342 if(isset($params['export'])) {
343 $this->export = $params['export'];
345 if(!empty($params['multiSelectPopup'])) {
346 $this->multi_select_popup = $params['multiSelectPopup'];
348 if(!empty($params['massupdate']) && $params['massupdate'] != false) {
349 $this->show_mass_update_form = true;
350 $this->mass = new MassUpdate();
351 $this->mass->setSugarBean($this->seed);
352 if(!empty($params['handleMassupdate']) || !isset($params['handleMassupdate'])) {
353 $this->mass->handleMassUpdate();
357 // create filter fields based off of display columns
358 if(empty($this->filter_fields) || $this->mergeDisplayColumns) {
359 foreach($this->displayColumns as $columnName => $def) {
360 $this->filter_fields[strtolower($columnName)] = true;
361 if(!empty($def['related_fields'])) {
362 foreach($def['related_fields'] as $field) {
363 //id column is added by query construction function. This addition creates duplicates
364 //and causes issues in oracle. #10165
365 if ($field != 'id') {
366 $this->filter_fields[$field] = true;
370 if (!empty($this->seed->field_defs[strtolower($columnName)]['db_concat_fields'])) {
371 foreach($this->seed->field_defs[strtolower($columnName)]['db_concat_fields'] as $index=>$field){
372 if(!isset($this->filter_fields[strtolower($field)]) || !$this->filter_fields[strtolower($field)])
374 $this->filter_fields[strtolower($field)] = true;
379 foreach ($this->searchColumns as $columnName => $def )
381 $this->filter_fields[strtolower($columnName)] = true;
386 if (!empty($_REQUEST['query']) || (!empty($GLOBALS['sugar_config']['save_query']) && $GLOBALS['sugar_config']['save_query'] != 'populate_only')) {
387 $data = $this->lvd->getListViewData($this->seed, $searchWhere, 0, -1, $this->filter_fields, $params, 'id');
389 $this->should_process = false;
393 'bean'=>array('moduleDir'=>$this->seed->module_dir),
395 'offsets'=>array('total'=>0,'next'=>0,'current'=>0),
400 foreach($this->displayColumns as $columnName => $def)
402 $seedName = strtolower($columnName);
404 if(empty($this->displayColumns[$columnName]['type'])){
405 if(!empty($this->lvd->seed->field_defs[$seedName]['type'])){
406 $seedDef = $this->lvd->seed->field_defs[$seedName];
407 $this->displayColumns[$columnName]['type'] = (!empty($seedDef['custom_type']))?$seedDef['custom_type']:$seedDef['type'];
409 $this->displayColumns[$columnName]['type'] = '';
413 if(!empty($this->lvd->seed->field_defs[$seedName]['options'])){
414 $this->displayColumns[$columnName]['options'] = $this->lvd->seed->field_defs[$seedName]['options'];
418 if($this->displayColumns[$columnName]['type'] == 'html') {
419 $cField = $this->seed->custom_fields;
420 if(isset($cField) && isset($cField->bean->$seedName)) {
421 $seedName2 = strtoupper($columnName);
422 $htmlDisplay = html_entity_decode($cField->bean->$seedName);
424 while($count < count($data['data'])) {
425 $data['data'][$count][$seedName2] = &$htmlDisplay;
431 if (!empty($this->lvd->seed->field_defs[$seedName]['sort_on'])) {
432 $this->displayColumns[$columnName]['orderBy'] = $this->lvd->seed->field_defs[$seedName]['sort_on'];
436 $this->process($file, $data, $this->seed->object_name);
440 * Return the where clause as per the REQUEST.
442 function _get_where_clause()
445 $where_clauses = $this->searchForm->generateSearchWhere(true, $this->seed->module_dir);
446 // Bug 43452 - FG - Changed the way generated Where array is imploded into the string.
447 // Now it's imploding in the same way view.list.php do.
448 if (count($where_clauses) > 0 ) {
449 $where = '( ' . implode(' and ', $where_clauses) . ' )';
452 // Need to include the default whereStatement
453 if(!empty($this->_popupMeta['whereStatement'])){
454 if(!empty($where))$where .= ' AND ';
455 $where .= $this->_popupMeta['whereStatement'];
462 * Generate the data for the search form on the header of the Popup.
464 function _build_field_defs(){
465 $this->formData = array();
466 $this->customFieldDefs = array();
467 foreach($this->searchdefs[$this->module]['layout']['advanced_search'] as $data){
470 $this->formData[] = array('field' => $data);
472 $this->customFieldDefs[$data['name']]= $data;
473 if(!empty($_REQUEST[$data['name']]))
474 $value = $_REQUEST[$data['name']];
475 $this->customFieldDefs[$data['name']]['value'] = $value;
477 $this->formData[] = array('field' => array('name'=>$data));
479 $this->fieldDefs = array();
481 $this->seed->fill_in_additional_detail_fields();
483 foreach($this->seed->toArray() as $name => $value) {
484 $this->fieldDefs[$name] = $this->seed->field_defs[$name];
485 //if we have a relate type then reset to name so that we end up with a textbox
486 //rather than a select button
487 $this->fieldDefs[$name]['name'] = $this->fieldDefs[$name]['name'];
488 if($this->fieldDefs[$name]['type'] == 'relate')
489 $this->fieldDefs[$name]['type'] = 'name';
490 if(isset($this->fieldDefs[$name]['options']) && isset($GLOBALS['app_list_strings'][$this->fieldDefs[$name]['options']])) {
491 $this->fieldDefs[$name]['options'] = $GLOBALS['app_list_strings'][$this->fieldDefs[$name]['options']]; // fill in enums
493 if(!empty($_REQUEST[$name]))
494 $value = $_REQUEST[$name];
495 $this->fieldDefs[$name]['value'] = $value;
500 function _getAddForm(){
502 if(!$this->seed->ACLAccess('save')){
505 if(!empty($this->_popupMeta['create'])){
506 $formBase = new $this->_popupMeta['create']['formBaseClass']();
510 // TODO: cleanup the construction of $addform
511 $prefix = empty($this->_popupMeta['create']['getFormBodyParams'][0]) ? '' : $this->_popupMeta['create']['getFormBodyParams'][0];
512 $mod = empty($this->_popupMeta['create']['getFormBodyParams'][1]) ? '' : $this->_popupMeta['create']['getFormBodyParams'][1];
513 $formBody = empty($this->_popupMeta['create']['getFormBodyParams'][2]) ? '' : $this->_popupMeta['create']['getFormBodyParams'][2];
515 $getFormMethod = (empty($this->_popupMeta['create']['getFormMethod']) ? 'getFormBody' : $this->_popupMeta['create']['getFormMethod']);
516 $formbody = $formBase->$getFormMethod($prefix, $mod, $formBody);
518 $addform = '<table><tr><td nowrap="nowrap" valign="top">'
519 . str_replace('<br>', '</td><td nowrap="nowrap" valign="top"> ', $formbody)
520 . '</td></tr></table>'
521 . '<input type="hidden" name="action" value="Popup" />';
527 function _getAddFormHeader(){
528 $lbl_save_button_title = $GLOBALS['app_strings']['LBL_SAVE_BUTTON_TITLE'];
529 $lbl_save_button_key = $GLOBALS['app_strings']['LBL_SAVE_BUTTON_KEY'];
530 $lbl_save_button_label = $GLOBALS['app_strings']['LBL_SAVE_BUTTON_LABEL'];
531 $module_dir = $this->seed->module_dir;
533 <input type="hidden" name="create" value="true">
534 <input type="hidden" name="popup" value="true">
535 <input type="hidden" name="to_pdf" value="true">
536 <input type="hidden" name="return_module" value="$module_dir">
537 <input type="hidden" name="return_action" value="Popup">
539 // if metadata contains custom inputs for the quickcreate
540 if(!empty($this->_popupMeta['customInput']) && is_array($this->_popupMeta['customInput'])) {
541 foreach($this->_popupMeta['customInput'] as $key => $value)
542 $formSave .= '<input type="hidden" name="' . $key . '" value="'. $value .'">\n';
546 $addformheader = get_form_header($this->_popupMeta['create']['createButton'], $formSave, false);
547 return $addformheader;
550 function getQuickCreate(){
551 require_once("include/EditView/PopupQuickCreate.php");
552 $qc = new PopupQuickCreate($this->module);
553 return $qc->process($this->module);