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);
83 * Processes the request. Calls ListViewData process. Also assigns all lang strings, export links,
84 * This is called from ListViewDisplay
86 * @param file file Template file to use
87 * @param data array from ListViewData
88 * @param html_var string the corresponding html var in xtpl per row
91 function process($file, $data, $htmlVar) {
93 global $odd_bg, $even_bg, $hilite_bg, $click_bg, $app_strings;
94 parent::process($file, $data, $htmlVar);
100 foreach($this->displayColumns as $name => $params) {
101 $totalWidth += $params['width'];
103 $adjustment = $totalWidth / 100;
105 $contextMenuObjectsTypes = array();
106 foreach($this->displayColumns as $name => $params) {
107 $this->displayColumns[$name]['width'] = round($this->displayColumns[$name]['width'] / $adjustment, 2);
108 // figure out which contextMenu objectsTypes are required
109 if(!empty($params['contextMenu']['objectType']))
110 $contextMenuObjectsTypes[$params['contextMenu']['objectType']] = true;
112 $this->th->ss->assign('displayColumns', $this->displayColumns);
115 $this->th->ss->assign('bgHilite', $hilite_bg);
116 $this->th->ss->assign('colCount', count($this->displayColumns) + 1);
117 $this->th->ss->assign('htmlVar', strtoupper($htmlVar));
118 $this->th->ss->assign('moduleString', $this->moduleString);
119 $this->th->ss->assign('editLinkString', $GLOBALS['app_strings']['LBL_EDIT_BUTTON']);
120 $this->th->ss->assign('viewLinkString', $GLOBALS['app_strings']['LBL_VIEW_BUTTON']);
123 $this->searchForm->parsedView = 'popup_query_form';
124 $this->searchForm->displayType = 'popupView';
125 $this->th->ss->assign('searchForm', $this->searchForm->display(false));
128 if($this->overlib) $this->th->ss->assign('overlib', true);
129 if($this->export) $this->th->ss->assign('exportLink', $this->buildExportLink());
130 $this->th->ss->assign('quickViewLinks', $this->quickViewLinks);
131 if($this->mailMerge) $this->th->ss->assign('mergeLink', $this->buildMergeLink()); // still check for mailmerge access
132 if($this->mergeduplicates) $this->th->ss->assign('mergedupLink', $this->buildMergeDuplicatesLink());
135 if (!empty($_REQUEST['mode']) && strtoupper($_REQUEST['mode']) == 'MULTISELECT') {
136 $this->multiSelect = true;
138 // handle save checks and stuff
139 if($this->multiSelect) {
140 $this->th->ss->assign('selectedObjectsSpan', $this->buildSelectedObjectsSpan());
141 $this->th->ss->assign('multiSelectData', $this->getMultiSelectData());
142 $this->th->ss->assign('MODE', "<input type='hidden' name='mode' value='MultiSelect'>");
143 $pageTotal = $this->data['pageData']['offsets']['next'] - $this->data['pageData']['offsets']['current'];
144 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
145 $pageTotal = $this->data['pageData']['offsets']['total'] - $this->data['pageData']['offsets']['current'];
147 $this->th->ss->assign('selectLink', $this->buildSelectLink('select_link', $this->data['pageData']['offsets']['total'], $pageTotal));
150 $this->processArrows($data['pageData']['ordering']);
151 $this->th->ss->assign('prerow', $this->multiSelect);
152 $this->th->ss->assign('rowColor', array('oddListRow', 'evenListRow'));
153 $this->th->ss->assign('bgColor', array($odd_bg, $even_bg));
154 $this->th->ss->assign('contextMenus', $this->contextMenus);
157 if($this->contextMenus && !empty($contextMenuObjectsTypes)) {
159 $cm = new contextMenu();
160 foreach($contextMenuObjectsTypes as $type => $value) {
161 $cm->loadFromFile($type);
162 $script .= $cm->getScript();
163 $cm->menuItems = array(); // clear menuItems out
165 $this->th->ss->assign('contextMenuScript', $script);
169 $this->_build_field_defs();
173 * Display the Smarty template. Here we are using the TemplateHandler for caching per the module.
175 function display($end = true) {
178 if(!is_file($GLOBALS['sugar_config']['cache_dir'] . 'jsLanguage/' . $GLOBALS['current_language'] . '.js')) {
179 require_once('include/language/jsLanguage.php');
180 jsLanguage::createAppStringsCache($GLOBALS['current_language']);
182 $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>';
184 $this->th->ss->assign('data', $this->data['data']);
185 $this->data['pageData']['offsets']['lastOffsetOnPage'] = $this->data['pageData']['offsets']['current'] + count($this->data['data']);
186 $this->th->ss->assign('pageData', $this->data['pageData']);
188 $navStrings = array('next' => $GLOBALS['app_strings']['LNK_LIST_NEXT'],
189 'previous' => $GLOBALS['app_strings']['LNK_LIST_PREVIOUS'],
190 'end' => $GLOBALS['app_strings']['LNK_LIST_END'],
191 'start' => $GLOBALS['app_strings']['LNK_LIST_START'],
192 'of' => $GLOBALS['app_strings']['LBL_LIST_OF']);
193 $this->th->ss->assign('navStrings', $navStrings);
196 $associated_row_data = array();
197 foreach($this->data['data'] as $val){
198 $associated_row_data[$val['ID']] = $val;
200 $is_show_fullname = showFullName() ? 1 : 0;
201 $json = getJSONobj();
202 $this->th->ss->assign('jsLang', $jsLang);
203 $this->th->ss->assign('lang', substr($GLOBALS['current_language'], 0, 2));
204 $this->th->ss->assign('headerTpl', 'include/Popups/tpls/header.tpl');
205 $this->th->ss->assign('footerTpl', 'include/Popups/tpls/footer.tpl');
206 $this->th->ss->assign('ASSOCIATED_JAVASCRIPT_DATA', 'var associated_javascript_data = '.$json->encode($associated_row_data). '; var is_show_fullname = '.$is_show_fullname.';');
207 $this->th->ss->assign('module', $this->seed->module_dir);
208 $request_data = empty($_REQUEST['request_data']) ? '' : $_REQUEST['request_data'];
209 $this->th->ss->assign('request_data', $request_data);
210 $this->th->ss->assign('fields', $this->fieldDefs);
211 $this->th->ss->assign('formData', $this->formData);
212 $this->th->ss->assign('APP', $GLOBALS['app_strings']);
213 $this->th->ss->assign('MOD', $GLOBALS['mod_strings']);
214 $this->th->ss->assign('popupMeta', $this->_popupMeta);
215 $this->th->ss->assign('current_query', base64_encode(serialize($_REQUEST)));
216 $this->th->ss->assign('customFields', $this->customFieldDefs);
217 $this->th->ss->assign('numCols', NUM_COLS);
218 $this->th->ss->assign('massUpdateData', $this->massUpdateData);
219 $this->th->ss->assign('jsCustomVersion', $GLOBALS['sugar_config']['js_custom_version']);
220 $this->th->ss->assign('sugarVersion', $GLOBALS['sugar_version']);
221 $this->th->ss->assign('should_process', $this->should_process);
224 $this->th->ss->assign('ADDFORM', $this->getQuickCreate());//$this->_getAddForm());
225 $this->th->ss->assign('ADDFORMHEADER', $this->_getAddFormHeader());
226 $this->th->ss->assign('object_name', $this->seed->object_name);
228 $this->th->ss->assign('LIST_HEADER', get_form_header($GLOBALS['mod_strings']['LBL_LIST_FORM_TITLE'], '', false));
229 $this->th->ss->assign('SEARCH_FORM_HEADER', get_form_header($GLOBALS['mod_strings']['LBL_SEARCH_FORM_TITLE'], '', false));
230 $str = $this->th->displayTemplate($this->seed->module_dir, $this->view, $this->tpl);
235 * Setup up the smarty template. we added an extra step here to add the order by from the popupdefs.
237 function setup($file) {
239 if(isset($this->_popupMeta)){
240 if(isset($this->_popupMeta['create']['formBase'])) {
241 require_once('modules/' . $this->seed->module_dir . '/' . $this->_popupMeta['create']['formBase']);
242 $this->_create = true;
245 if(!empty($this->_popupMeta['create'])){
246 $formBase = new $this->_popupMeta['create']['formBaseClass']();
247 if(isset($_REQUEST['doAction']) && $_REQUEST['doAction'] == 'save')
249 //If it's a new record, set useRequired to false
250 $useRequired = empty($_REQUEST['id']) ? false : true;
251 $formBase->handleSave('', false, $useRequired);
256 if(!empty($this->_popupMeta['orderBy'])){
257 $params['orderBy'] = $this->_popupMeta['orderBy'];
260 if(file_exists('custom/modules/'.$this->module.'/metadata/metafiles.php')){
261 require('custom/modules/'.$this->module.'/metadata/metafiles.php');
262 }elseif(file_exists('modules/'.$this->module.'/metadata/metafiles.php')){
263 require('modules/'.$this->module.'/metadata/metafiles.php');
266 if(!empty($metafiles[$this->module]['searchfields'])) {
267 require($metafiles[$this->module]['searchfields']);
268 } elseif(file_exists('modules/'.$this->module.'/metadata/SearchFields.php')) {
269 require('modules/'.$this->module.'/metadata/SearchFields.php');
271 $this->searchdefs[$this->module]['templateMeta']['maxColumns'] = 2;
272 $this->searchdefs[$this->module]['templateMeta']['widths']['label'] = 10;
273 $this->searchdefs[$this->module]['templateMeta']['widths']['field'] = 30;
275 $this->searchForm->view = 'PopupSearchForm';
276 $this->searchForm->setup($this->searchdefs, $searchFields, 'include/SearchForm/tpls/SearchFormGenericAdvanced.tpl', 'advanced_search', $this->listviewdefs);
278 $lv = new ListViewSmarty();
279 $displayColumns = array();
280 if(!empty($_REQUEST['displayColumns'])) {
281 foreach(explode('|', $_REQUEST['displayColumns']) as $num => $col) {
282 if(!empty($listViewDefs[$this->module][$col]))
283 $displayColumns[$col] = $this->listviewdefs[$this->module][$col];
287 foreach($this->listviewdefs[$this->module] as $col => $para) {
288 if(!empty($para['default']) && $para['default'])
289 $displayColumns[$col] = $para;
292 $params['massupdate'] = true;
293 if(!empty($_REQUEST['orderBy'])) {
294 $params['orderBy'] = $_REQUEST['orderBy'];
295 $params['overrideOrder'] = true;
296 if(!empty($_REQUEST['sortOrder'])) $params['sortOrder'] = $_REQUEST['sortOrder'];
299 $lv->displayColumns = $displayColumns;
300 $this->searchForm->lv = $lv;
301 $this->searchForm->displaySavedSearch = false;
304 $this->searchForm->populateFromRequest('advanced_search');
305 $searchWhere = $this->_get_where_clause();
306 $this->searchColumns = $this->searchForm->searchColumns;
307 //parent::setup($this->seed, $file, $searchWhere, $params, 0, -1, $this->filter_fields);
309 $this->should_process = true;
311 if(isset($params['export'])) {
312 $this->export = $params['export'];
314 if(!empty($params['multiSelectPopup'])) {
315 $this->multi_select_popup = $params['multiSelectPopup'];
317 if(!empty($params['massupdate']) && $params['massupdate'] != false) {
318 $this->show_mass_update_form = true;
319 $this->mass = new MassUpdate();
320 $this->mass->setSugarBean($this->seed);
321 if(!empty($params['handleMassupdate']) || !isset($params['handleMassupdate'])) {
322 $this->mass->handleMassUpdate();
326 // create filter fields based off of display columns
327 if(empty($this->filter_fields) || $this->mergeDisplayColumns) {
328 foreach($this->displayColumns as $columnName => $def) {
329 $this->filter_fields[strtolower($columnName)] = true;
330 if(!empty($def['related_fields'])) {
331 foreach($def['related_fields'] as $field) {
332 //id column is added by query construction function. This addition creates duplicates
333 //and causes issues in oracle. #10165
334 if ($field != 'id') {
335 $this->filter_fields[$field] = true;
339 if (!empty($this->seed->field_defs[strtolower($columnName)]['db_concat_fields'])) {
340 foreach($this->seed->field_defs[strtolower($columnName)]['db_concat_fields'] as $index=>$field){
341 if(!isset($this->filter_fields[strtolower($field)]) || !$this->filter_fields[strtolower($field)])
343 $this->filter_fields[strtolower($field)] = true;
348 foreach ($this->searchColumns as $columnName => $def )
350 $this->filter_fields[strtolower($columnName)] = true;
355 if (!empty($_REQUEST['query']) || (!empty($GLOBALS['sugar_config']['save_query']) && $GLOBALS['sugar_config']['save_query'] != 'populate_only')) {
356 $data = $this->lvd->getListViewData($this->seed, $searchWhere, 0, -1, $this->filter_fields, $params, 'id');
358 $this->should_process = false;
362 'bean'=>array('moduleDir'=>$this->seed->module_dir),
364 'offsets'=>array('total'=>0,'next'=>0,'current'=>0),
369 foreach($this->displayColumns as $columnName => $def)
371 $seedName = strtolower($columnName);
373 if(empty($this->displayColumns[$columnName]['type'])){
374 if(!empty($this->lvd->seed->field_defs[$seedName]['type'])){
375 $seedDef = $this->lvd->seed->field_defs[$seedName];
376 $this->displayColumns[$columnName]['type'] = (!empty($seedDef['custom_type']))?$seedDef['custom_type']:$seedDef['type'];
378 $this->displayColumns[$columnName]['type'] = '';
382 if(!empty($this->lvd->seed->field_defs[$seedName]['options'])){
383 $this->displayColumns[$columnName]['options'] = $this->lvd->seed->field_defs[$seedName]['options'];
387 if($this->displayColumns[$columnName]['type'] == 'html') {
388 $cField = $this->seed->custom_fields;
389 if(isset($cField) && isset($cField->bean->$seedName)) {
390 $seedName2 = strtoupper($columnName);
391 $htmlDisplay = html_entity_decode($cField->bean->$seedName);
393 while($count < count($data['data'])) {
394 $data['data'][$count][$seedName2] = &$htmlDisplay;
400 if (!empty($this->lvd->seed->field_defs[$seedName]['sort_on'])) {
401 $this->displayColumns[$columnName]['orderBy'] = $this->lvd->seed->field_defs[$seedName]['sort_on'];
405 $this->process($file, $data, $this->seed->object_name);
409 * Return the where clause as per the REQUEST.
411 function _get_where_clause()
414 $where_clauses = $this->searchForm->generateSearchWhere(true, $this->seed->module_dir);
415 if (count($where_clauses) > 0 )$where= implode(' and ', $where_clauses);
417 // Need to include the default whereStatement
418 if(!empty($this->_popupMeta['whereStatement'])){
419 if(!empty($where))$where .= ' AND ';
420 $where .= $this->_popupMeta['whereStatement'];
427 * Generate the data for the search form on the header of the Popup.
429 function _build_field_defs(){
430 $this->formData = array();
431 $this->customFieldDefs = array();
432 foreach($this->searchdefs[$this->module]['layout']['advanced_search'] as $data){
435 $this->formData[] = array('field' => $data);
437 $this->customFieldDefs[$data['name']]= $data;
438 if(!empty($_REQUEST[$data['name']]))
439 $value = $_REQUEST[$data['name']];
440 $this->customFieldDefs[$data['name']]['value'] = $value;
442 $this->formData[] = array('field' => array('name'=>$data));
444 $this->fieldDefs = array();
446 $this->seed->fill_in_additional_detail_fields();
448 foreach($this->seed->toArray() as $name => $value) {
449 $this->fieldDefs[$name] = $this->seed->field_defs[$name];
450 //if we have a relate type then reset to name so that we end up with a textbox
451 //rather than a select button
452 $this->fieldDefs[$name]['name'] = $this->fieldDefs[$name]['name'];
453 if($this->fieldDefs[$name]['type'] == 'relate')
454 $this->fieldDefs[$name]['type'] = 'name';
455 if(isset($this->fieldDefs[$name]['options']) && isset($GLOBALS['app_list_strings'][$this->fieldDefs[$name]['options']])) {
456 $this->fieldDefs[$name]['options'] = $GLOBALS['app_list_strings'][$this->fieldDefs[$name]['options']]; // fill in enums
458 if(!empty($_REQUEST[$name]))
459 $value = $_REQUEST[$name];
460 $this->fieldDefs[$name]['value'] = $value;
465 function _getAddForm(){
467 if(!$this->seed->ACLAccess('save')){
470 if(!empty($this->_popupMeta['create'])){
471 $formBase = new $this->_popupMeta['create']['formBaseClass']();
475 // TODO: cleanup the construction of $addform
476 $prefix = empty($this->_popupMeta['create']['getFormBodyParams'][0]) ? '' : $this->_popupMeta['create']['getFormBodyParams'][0];
477 $mod = empty($this->_popupMeta['create']['getFormBodyParams'][1]) ? '' : $this->_popupMeta['create']['getFormBodyParams'][1];
478 $formBody = empty($this->_popupMeta['create']['getFormBodyParams'][2]) ? '' : $this->_popupMeta['create']['getFormBodyParams'][2];
480 $getFormMethod = (empty($this->_popupMeta['create']['getFormMethod']) ? 'getFormBody' : $this->_popupMeta['create']['getFormMethod']);
481 $formbody = $formBase->$getFormMethod($prefix, $mod, $formBody);
483 $addform = '<table><tr><td nowrap="nowrap" valign="top">'
484 . str_replace('<br>', '</td><td nowrap="nowrap" valign="top"> ', $formbody)
485 . '</td></tr></table>'
486 . '<input type="hidden" name="action" value="Popup" />';
492 function _getAddFormHeader(){
493 $lbl_save_button_title = $GLOBALS['app_strings']['LBL_SAVE_BUTTON_TITLE'];
494 $lbl_save_button_key = $GLOBALS['app_strings']['LBL_SAVE_BUTTON_KEY'];
495 $lbl_save_button_label = $GLOBALS['app_strings']['LBL_SAVE_BUTTON_LABEL'];
496 $module_dir = $this->seed->module_dir;
498 <input type="hidden" name="create" value="true">
499 <input type="hidden" name="popup" value="true">
500 <input type="hidden" name="to_pdf" value="true">
501 <input type="hidden" name="return_module" value="$module_dir">
502 <input type="hidden" name="return_action" value="Popup">
504 // if metadata contains custom inputs for the quickcreate
505 if(!empty($this->_popupMeta['customInput']) && is_array($this->_popupMeta['customInput'])) {
506 foreach($this->_popupMeta['customInput'] as $key => $value)
507 $formSave .= '<input type="hidden" name="' . $key . '" value="'. $value .'">\n';
511 $addformheader = get_form_header($this->_popupMeta['create']['createButton'], $formSave, false);
512 return $addformheader;
515 function getQuickCreate(){
516 require_once("include/EditView/PopupQuickCreate.php");
517 $qc = new PopupQuickCreate($this->module);
518 return $qc->process($this->module);