salesagility_SuiteCRM/include/ListView/ListViewSmarty.php

<?php
/**
 *
 * SugarCRM Community Edition is a customer relationship management program developed by
 * SugarCRM, Inc. Copyright (C) 2004-2013 SugarCRM Inc.
 *
 * SuiteCRM is an extension to SugarCRM Community Edition developed by SalesAgility Ltd.
 * Copyright (C) 2011 - 2018 SalesAgility Ltd.
 *
 * 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 and "Supercharged by SuiteCRM" logo. If the display of the logos is not
 * reasonably feasible for technical reasons, the Appropriate Legal Notices must
 * display the words "Powered by SugarCRM" and "Supercharged by SuiteCRM".
 */

if (!defined('sugarEntry') || !sugarEntry) {
    die('Not A Valid Entry Point');
}

require_once('include/ListView/ListViewDisplay.php');


require_once('include/contextMenus/contextMenu.php');
#[\AllowDynamicProperties]
class ListViewSmarty extends ListViewDisplay
{
    public $data;
    public $ss; // the smarty object
    public $displayColumns;
    public $searchColumns; // set by view.list.php
    public $tpl;
    public $moduleString;
    public $export = true;
    public $delete = true;
    public $select = true;
    public $mailMerge = true;
    public $email = true;
    public $targetList = false;
    public $multiSelect = true;
    public $quickViewLinks = true;
    public $lvd;
    public $mergeduplicates = true;
    public $contextMenus = true;
    public $showMassupdateFields = true;
    public $menu_location = 'top';
    public $templateMeta = array();
    public $displayEmptyDataMessages = null;

    /**
     * Constructor, Smarty object immediately available after
     *
     */
    public function __construct()
    {
        parent::__construct();
        $this->ss = new Sugar_Smarty();
    }

    /**
     *
     * @return string|boolean
     */
    public function buildSendConfirmOptInEmailToPersonAndCompany()
    {
        $configurator = new Configurator();
        if (!$configurator->isConfirmOptInEnabled()) {
            return false;
        }

        $linkTpl = new Sugar_Smarty();
        $linkTpl->assign('module_name', $this->seed->module_name);
        $linkHTML = $linkTpl->fetch('include/ListView/ListViewBulkActionSendOptInLink.tpl');

        return $linkHTML;
    }

    /**
     * Processes the request. Calls ListViewData process. Also assigns all lang strings, export links,
     * This is called from ListViewDisplay
     *
     * @param file $file Template file to use
     * @param array $data from ListViewData
     * @param string $htmlVar the corresponding html public in xtpl per row
     *
     */
    public function process($file, $data, $htmlpublic)
    {
        global $mod_strings;
        if (!$this->should_process) {
            return;
        }
        global $odd_bg, $even_bg, $hilite_bg, $app_strings, $sugar_config;

        $seedClass = get_parent_class($this->seed);
        if (in_array($seedClass, array('Company', 'Person'), true)) {
            $configurator = new Configurator();
            if ($configurator->isConfirmOptInEnabled()) {
                $sendConfirmOptInEmailToPersonAndCompany = $this->buildSendConfirmOptInEmailToPersonAndCompany();
                if (!in_array($sendConfirmOptInEmailToPersonAndCompany, $this->actionsMenuExtraItems, true)) {
                    $this->actionsMenuExtraItems[] = $this->buildSendConfirmOptInEmailToPersonAndCompany();
                }
            }
        }

        parent::process($file, $data, $htmlpublic);

        $this->tpl = $file;
        $this->data = $data;

        $totalWidth = 0;
        foreach ((array)$this->displayColumns as $name => $params) {
            $totalWidth += isset($params['width'])? (int)$params['width'] : 0;
        }
        $adjustment = $totalWidth / 100;

        $contextMenuObjectsTypes = array();
        foreach ((array)$this->displayColumns as $name => $params) {
            if (!isset($this->displayColumns[$name]['width']) || 0 === $adjustment) {
                $this->displayColumns[$name]['width'] = 0;
            } else {
                $this->displayColumns[$name]['width'] = floor(((int)$this->displayColumns[$name]['width']) / $adjustment);
            }

            // figure out which contextMenu objectsTypes are required
            if (!empty($params['contextMenu']['objectType'])) {
                $contextMenuObjectsTypes[$params['contextMenu']['objectType']] = true;
            }
        }

        //Check if inline editing is enabled for list view.
        if (!isset($sugar_config['enable_line_editing_list']) || $sugar_config['enable_line_editing_list']) {
            $this->ss->assign('inline_edit', true);
        }

        if (!isset($sugar_config['hide_subpanels']) || $sugar_config['hide_subpanels']) {
            $this->ss->assign('hide_subpanels', true);
        }

        $this->ss->assign('sugarconfig', $this->displayColumns);
        $this->ss->assign('displayColumns', $this->displayColumns);
        $this->ss->assign('options', isset($this->templateMeta['options']) ? $this->templateMeta['options'] : null);
        $this->ss->assign('form', isset($this->templateMeta['form']) ? $this->templateMeta['form'] : null);
        $this->ss->assign('includes', isset($this->templateMeta['includes']) ? $this->templateMeta['includes'] : null);

        $this->ss->assign('APP', $app_strings);
        $this->ss->assign('MOD', $mod_strings);

        $this->ss->assign('bgHilite', $hilite_bg);
        $this->ss->assign('colCount', count((array)$this->displayColumns) + 10);
        $this->ss->assign('htmlpublic', strtoupper($htmlpublic));
        $this->ss->assign('moduleString', $this->moduleString);
        $this->ss->assign('editLinkString', $app_strings['LBL_EDIT_BUTTON']);
        $this->ss->assign('viewLinkString', $app_strings['LBL_VIEW_BUTTON']);
        $this->ss->assign('allLinkString', $app_strings['LBL_LINK_ALL']);
        $this->ss->assign('noneLinkString', $app_strings['LBL_LINK_NONE']);
        $this->ss->assign('recordsLinkString', $app_strings['LBL_LINK_RECORDS']);
        $this->ss->assign('selectLinkString', $app_strings['LBL_LINK_SELECT']);

        if (!isset($this->data['pageData']['offsets'])) {
            $GLOBALS['log']->warn('Incorrect pageData: offset is not set');
        } else {
            // Bug 24677 - Correct the page total amount on the last page of listviews
            $pageTotal = $this->data['pageData']['offsets']['next'] - $this->data['pageData']['offsets']['current'];
            if ($this->data['pageData']['offsets']['next'] < 0) {
                $pageTotal = $this->data['pageData']['offsets']['total'] - $this->data['pageData']['offsets']['current'];
            }

            if ($this->select) {
                $this->ss->assign('selectLinkTop', $this->buildSelectLink('select_link', $this->data['pageData']['offsets']['total'], $pageTotal));
            }
            if ($this->select) {
                $this->ss->assign('selectLinkBottom', $this->buildSelectLink('select_link', $this->data['pageData']['offsets']['total'], $pageTotal, "bottom"));
            }
        }

        if ($this->show_action_dropdown) {
            $action_menu = $this->buildActionsLink();
            $this->ss->assign('actionsLinkTop', $action_menu);
            if (count($action_menu['buttons']) > 0) {
                $this->ss->assign('actionDisabledLink', preg_replace("/id\s*\=(\"\w+\"|w+)/i", "", $action_menu['buttons'][0]));
            }
            $menu_location = 'bottom';
            $this->ss->assign('actionsLinkBottom', $this->buildActionsLink('actions_link', $menu_location));
        }

        $this->ss->assign('quickViewLinks', $this->quickViewLinks);

        // handle save checks and stuff
        if ($this->multiSelect) {
            $this->ss->assign('multiSelectData', $this->getMultiSelectData());
        } else {
            $this->ss->assign('multiSelectData', '<textarea style="display: none" name="uid"></textarea>');
        }
        // include button for Adding to Target List if in one of four applicable modules
        if (isset($_REQUEST['module']) && in_array($_REQUEST['module'], array( 'Contacts','Prospects','Leads','Accounts' ))
            && ACLController::checkAccess('ProspectLists', 'edit', true)) {
            $this->ss->assign('targetLink', $this->buildTargetList()) ;
        }

        if (!isset($data['pageData']['ordering'])) {
            $GLOBALS['log']->warn("Incorrect pageData: ordering is not set");
        } else {
            $this->processArrows($data['pageData']['ordering']);
        }

        $this->ss->assign('prerow', $this->multiSelect);
        $this->ss->assign('clearAll', $app_strings['LBL_CLEARALL']);
        $this->ss->assign('rowColor', array('oddListRow', 'evenListRow'));
        $this->ss->assign('bgColor', array($odd_bg, $even_bg));
        $this->ss->assign('contextMenus', $this->contextMenus);
        $this->ss->assign('is_admin_for_user', $GLOBALS['current_user']->isAdminForModule('Users'));
        $this->ss->assign('is_admin', $GLOBALS['current_user']->isAdmin());


        if ($this->contextMenus && !empty($contextMenuObjectsTypes)) {
            $script = '';
            $cm = new contextMenu();
            foreach ($contextMenuObjectsTypes as $type => $value) {
                $cm->loadFromFile($type);
                $script .= $cm->getScript();
                $cm->menuItems = array(); // clear menuItems out
            }
            $this->ss->assign('contextMenuScript', $script);
        }

        $module = $_REQUEST['module'] ?? null;

        if (isset($sugar_config['hideColumnFilter'][$module]) && $sugar_config['hideColumnFilter'][$module]) {
            $this->ss->assign('hideColumnFilter', true);
        }

        $this->ss->assign('showFilterIcon', !in_array($module, $sugar_config['enable_legacy_search'] ?? array()));
    }

    /**
     * Assigns the sort arrows in the tpl
     *
     * @param ordering array data that contains the ordering info
     *
     */
    public function processArrows($ordering)
    {
        $pathParts = pathinfo(SugarThemeRegistry::current()->getImageURL('arrow.gif', false));

        list($width, $height) = getimagesize($pathParts['dirname'].'/'.$pathParts['basename']);

        $this->ss->assign('arrowExt', $pathParts['extension']);
        $this->ss->assign('arrowWidth', $width);
        $this->ss->assign('arrowHeight', $height);
        $this->ss->assign('arrowAlt', translate('LBL_SORT'));
    }



    /**
     * Displays the xtpl, either echo or returning the contents
     *
     * @param end bool display the ending of the listview data (ie MassUpdate)
     *
     */
    public function display($end = true)
    {
        if (!$this->should_process) {
            return $this->getSearchIcon().$GLOBALS['app_strings']['LBL_SEARCH_POPULATE_ONLY'];
        }
        global $app_strings, $sugar_version, $sugar_flavor, $currentModule, $app_list_strings;
        $this->ss->assign('moduleListSingular', $app_list_strings["moduleListSingular"]);
        $this->ss->assign('moduleList', $app_list_strings['moduleList']);
        $this->ss->assign('data', $this->data['data'] ?? []);
        $this->ss->assign('query', $this->data['query'] ?? '');
        $this->ss->assign('sugar_info', array("sugar_version" => $sugar_version,
            "sugar_flavor" => $sugar_flavor));

        if (!isset($this->data['pageData']['offsets'])) {
            $GLOBALS['log']->warn("Incorrect pageData: trying to display but offset is not set");
        } else {
            if (!isset($this->data['data'])) {
                $data['data'] = null;
                LoggerManager::getLogger()->warn('List view smarty data must be an array, undefined data given and converting to an empty array.');
            } elseif (!is_array($this->data['data'])) {
                LoggerManager::getLogger()->warn('List view smarty data must be an array, ' . gettype($this->data['data']) . ' given and converting to an array.');
            }
            $this->data['pageData']['offsets']['lastOffsetOnPage'] = $this->data['pageData']['offsets']['current'] + count((array)$this->data['data']);
        }

        $this->ss->assign('pageData', $this->data['pageData'] ?? []);

        $navStrings = array('next' => $app_strings['LNK_LIST_NEXT'],
            'previous' => $app_strings['LNK_LIST_PREVIOUS'],
            'end' => $app_strings['LNK_LIST_END'],
            'start' => $app_strings['LNK_LIST_START'],
            'of' => $app_strings['LBL_LIST_OF']);
        $this->ss->assign('navStrings', $navStrings);

        if ($this->displayEmptyDataMessages === null) {
            $displayEmptyDataMessages = true;
        } else {
            $displayEmptyDataMessages = $this->displayEmptyDataMessages;
        }
        //TODO: Cleanup, better logic for which modules are exempt from the new messaging.
        $modulesExemptFromEmptyDataMessages = array('WorkFlow','ContractTypes', 'OAuthKeys', 'TimePeriods');
        if ((isset($GLOBALS['moduleTabMap'][$currentModule]) && $GLOBALS['moduleTabMap'][$currentModule] == 'Administration')
            || isset($GLOBALS['adminOnlyList'][$currentModule]) || in_array($currentModule, $modulesExemptFromEmptyDataMessages)) {
            $displayEmptyDataMessages = false;
        }
        $this->ss->assign('displayEmptyDataMesssages', $displayEmptyDataMessages);

        $str = parent::display();
        $strend = $this->displayEnd();

        return $str . $this->ss->fetch($this->tpl) . (($end) ? $strend : '');
    }


    private function getSearchIcon()
    {
        global $sugar_config;

        $searchFormInPopup = !in_array($_REQUEST['module'], isset($sugar_config['enable_legacy_search']) ? $sugar_config['enable_legacy_search'] : array());
        if ($sugar_config['save_query'] == 'populate_only' && !$searchFormInPopup) {
            return ;
        }
        $ss = new Sugar_Smarty();
        $ss->assign('currentModule', $_REQUEST['module']);
        return $ss->fetch('include/ListView/ListViewSearchLink.tpl') . '<br>';
    }


    public function displayEnd()
    {
        $str = '';
        if ($this->show_mass_update_form) {
            if ($this->showMassupdateFields) {
                $str .= $this->mass->getMassUpdateForm(true);
            }
            $str .= $this->mass->endMassUpdateForm();
        }

        return $str;
    }
}