una/modules/base/general/classes/BxBaseModGeneralSearchResult.php

<?php defined('BX_DOL') or die('hack attempt');
/**
 * Copyright (c) UNA, Inc - https://una.io
 * MIT License - https://opensource.org/licenses/MIT
 *
 * @defgroup    BaseGeneral Base classes for modules
 * @ingroup     UnaModules
 *
 * @{
 */

define('BX_SYS_PER_PAGE_BROWSE_SHOWCASE', 32);

class BxBaseModGeneralSearchResult extends BxTemplSearchResult
{
    protected $oModule;
    protected $sFilterName;
    protected $bShowcaseView = false;
    protected $aUnitViews = array();
    protected $sUnitViewDefault = 'gallery';

    function __construct($sMode = '', $aParams = array())
    {
        $this->_sMode = $sMode;
        $this->_aParams = $aParams;

        parent::__construct();
    }

    function getMain()
    {
        if(!$this->oModule)
            $this->oModule = BxDolModule::getInstance($this->getModuleName());

        return $this->oModule;
    }

    function getContentInfoObject()
    {
        return BxDolContentInfo::getObjectInstance($this->getContentInfoName());
    }
    
    function getFieldsOwn()
    {
        $mixedFields = getParam($this->getModuleName() . '_browse_fields_own');
        if(empty($mixedFields))
            return false;

        if(($aFields = json_decode($mixedFields, true)) !== null)
            return $aFields;

        $sDelimiter = ',';
        if(strpos($mixedFields, $sDelimiter) !== false)
            return explode($sDelimiter, $mixedFields);

        return false;
    }

    function getFieldsJoin($sJoin)
    {
        $mixedFields = getParam($this->getModuleName() . '_browse_fields_join');
        if(empty($mixedFields))
            return false;

        return ($aJoins = json_decode($mixedFields, true)) !== null && !empty($aJoins[$sJoin]) ? $aJoins[$sJoin] : false;
    }

    function getRssUnitLink (&$a)
    {
        $CNF = &$this->oModule->_oConfig->CNF;

        return bx_absolute_url(BxDolPermalinks::getInstance()->permalink('page.php?i=' . $CNF['URI_VIEW_ENTRY'] . '&id=' . $a[$CNF['FIELD_ID']]));
    }

    function getRssPageUrl ()
    {
        if (false === parent::getRssPageUrl())
            return false;

        $oPermalinks = BxDolPermalinks::getInstance();
        return bx_absolute_url($oPermalinks->permalink($this->aCurrent['rss']['link']));
    }

    function rss ()
    {
        if (!isset($this->aCurrent['rss']))
            return '';

        $this->aCurrent['paginate']['perPage'] = empty($this->oModule->_oConfig->CNF['PARAM_NUM_RSS']) ? 10 : getParam($this->oModule->_oConfig->CNF['PARAM_NUM_RSS']);

        return parent::rss();
    }

    function processingAPI ($bForceGetData = false) 
    {
        $aResult = parent::processingAPI($bForceGetData);

        if(isset($this->_aParams['filters']) && is_array($this->_aParams['filters'])) {
            $oModule = $this->getMain();

            if(!empty($this->_aParams['filters']['values']) && is_array($this->_aParams['filters']['values']))
                $aResult['params']['filters'] = $this->_aParams['filters']['values'];

            $mixedFilters = $oModule->_oTemplate->getBrowsingFilters(array_merge(['mode' => $this->_sMode], $this->_aParams));
            if($mixedFilters)
                $aResult['filters'] = $mixedFilters;
        }

        return $aResult;
    }

    protected function addCustomConditions($CNF, $oProfile, $sMode, $aParams)
    {
        $this->addConditionsForAuthorStatus($CNF);

        $this->addConditionsForCf($CNF);

        if(!empty($aParams['filter']) && is_array($aParams['filter']))
            $this->addConditionsForFilter($CNF, $sMode, $aParams);

        $this->addConditionsForSearchFilters($CNF, $aParams);
    }

    /**
     * Search-form values posted as params.filters ({title: "toy"}).
     * Operators come from the module's extended search fields, so a value
     * is applied only when that field is an active search field on the entries table.
     */
    protected function addConditionsForSearchFilters($CNF, $aParams)
    {
        $aValues = [];
        if(!empty($aParams['filters']['values']) && is_array($aParams['filters']['values']))
            $aValues = $aParams['filters']['values'];
        elseif(!empty($aParams['filters']) && is_array($aParams['filters']) && !isset($aParams['filters']['onclick']))
            $aValues = $aParams['filters'];

        if(!$aValues || !($sModule = $this->getModuleName()))
            return;

        $sTable = !empty($CNF['TABLE_ENTRIES']) ? $CNF['TABLE_ENTRIES'] : ($this->aCurrent['table'] ?? '');
        if($sTable === '')
            return;

        $oDb = BxDolDb::getInstance();
        $aFields = $oDb->getPairs(
            "SELECT `name`, `search_operator` FROM `sys_search_extended_fields` WHERE `object` = :object AND `active` = 1",
            'name',
            'search_operator',
            ['object' => $sModule]
        );
        if(empty($aFields) || !is_array($aFields))
            return;

        foreach($aValues as $sName => $mixedValue) {
            if(!is_string($sName) || !isset($aFields[$sName]) || !preg_match('/^[A-Za-z0-9_]+$/', $sName))
                continue;

            $sOperator = $aFields[$sName];
            if($sOperator === '' || $this->_isSearchFilterEmpty($mixedValue))
                continue;

            if(!$oDb->isFieldExists($sTable, $sName))
                continue;

            $aRestriction = [
                'field' => $sName,
                'table' => $sTable,
                'operator' => $sOperator,
                'value' => $mixedValue,
            ];

            switch($sOperator) {
                case 'like':
                case '=':
                    if(is_array($mixedValue))
                        continue 2;
                    break;

                case 'in':
                case 'not in':
                    $aRestriction['value'] = is_array($mixedValue) ? $mixedValue : [$mixedValue];
                    break;

                case 'between':
                    if(!is_array($mixedValue))
                        continue 2;
                    break;

                default:
                    continue 2;
            }

            $this->aCurrent['restriction']['search_' . $sName] = $aRestriction;
        }
    }

    protected function _isSearchFilterEmpty($mixedValue)
    {
        if($mixedValue === null || $mixedValue === '' || $mixedValue === false)
            return true;

        if(!is_array($mixedValue))
            return false;

        foreach($mixedValue as $mixedItem)
            if(!$this->_isSearchFilterEmpty($mixedItem))
                return false;

        return true;
    }

    protected function addConditionsForAuthorStatus($CNF)
    {
        if (empty($CNF['FIELD_AUTHOR']))
            return;

        $this->aCurrent['restriction']['statusAuthor'] = [
            'value' => 'active',
            'field' => 'status',
            'operator' => '=',
            'table' => 'sys_profiles',
        ];

        $this->aCurrent['join']['statusAuthor'] = [
            'type' => 'INNER',
            'table' => 'sys_profiles',
            'mainField' => $CNF['FIELD_AUTHOR'],
            'mainFieldFunc' => 'ABS',
            'onField' => 'id',
            'joinFields' => array(),
        ];
    }

    protected function addConditionsForCf($CNF)
    {
        if(empty($CNF['FIELD_CF']))
            return;

        $oCf = BxDolContentFilter::getInstance();
        if(!$oCf->isEnabled()) 
            return;

        $aConditions = $oCf->getConditions($this->aCurrent['table'], $CNF['FIELD_CF']);
        if(!empty($aConditions) && is_array($aConditions))
            $this->aCurrent['restriction'] = array_merge($this->aCurrent['restriction'], $aConditions);
    }
    
    protected function addConditionsForFilter($CNF, $sMode, $aParams)
    {
        $aFilter = $aParams['filter'];
        
        if(empty($aFilter['field']) || empty($aFilter['value']))
            return;
        
        $aRestriction = [
            'value' => $aFilter['value'],
            'field' => $aFilter['field'],
            'operator' => '=',
        ];

        if(isset($aFilter['operator']))
            $aRestriction['operator'] = $aFilter['operator'];

        if(isset($aFilter['table']))
            switch($aFilter['table']) {
                case 'table':
                    $aRestriction['table'] = $this->aCurrent['table'];
                    break;

                case 'tableSearch':
                    $aRestriction['table'] = $this->aCurrent['tableSearch'];
                    break;

                default: 
                    $aRestriction['table'] = $aFilter['table'];
            }

        $this->aCurrent['restriction']['filter'] = $aRestriction;
    }

    /**
     * Add conditions for private content
     */
    protected function addConditionsForPrivateContent($CNF, $oProfile, $aCustomGroup = array()) 
    {
        // default is bProcessPrivateContent = 1, 
        // so private items are shown as empty boxes with "Private" title

        // we can show public content when privacy object is available
        
        if(empty($CNF['OBJECT_PRIVACY_VIEW']))
            return;

        $oPrivacy = BxDolPrivacy::getObjectInstance($CNF['OBJECT_PRIVACY_VIEW']);
        if(!$oPrivacy)
            return;

        // for posts in some context we need to show all items, not only public content
        if (!empty($this->aCurrent['restriction']['context']['value']) || !empty($this->aCurrent['restriction']['author']['value'])) {
            $this->setProcessPrivateContent(true);
            return;
        }

        // build condition to show only public content
        $aCondition = $oPrivacy->getContentPublicAsCondition($oProfile ? $oProfile->id() : 0, $aCustomGroup);
        if(empty($aCondition) || !is_array($aCondition))
            return;

        if(isset($aCondition['restriction'])) {
            $this->aCurrent['restriction'] = array_merge($this->aCurrent['restriction'], $aCondition['restriction']);
            $this->aPrivateConditionsIndexes['restriction'] = array_keys($aCondition['restriction']);
        }
        if(isset($aCondition['join'])) {
            $this->aCurrent['join'] = array_merge($this->aCurrent['join'], $aCondition['join']);
            $this->aPrivateConditionsIndexes['join'] = array_keys($aCondition['join']);
        }

        $this->setProcessPrivateContent(false);
    }

    function showPagination($bAdmin = false, $bChangePage = true, $bPageReload = true)
    {
        if($this->bShowcaseView)
            return '';

        $sPagination = parent::showPagination ($bAdmin, $bChangePage, $bPageReload);
        if(empty($sPagination))
            return '';

        return $sPagination;
    }

    protected function getItemPerPageInShowCase ()
    {
        $iPerPageInShowCase = (int)getParam('sys_per_page_browse_showcase');

        $CNF = &$this->oModule->_oConfig->CNF;
        if(isset($CNF['PARAM_PER_PAGE_BROWSE_SHOWCASE']))
            $iPerPageInShowCase = (int)getParam($CNF['PARAM_PER_PAGE_BROWSE_SHOWCASE']);

        if(!$iPerPageInShowCase)
            $iPerPageInShowCase = BX_SYS_PER_PAGE_BROWSE_SHOWCASE;

        return $iPerPageInShowCase;
    }

    function displayResultBlock()
    {
        if ($this->bShowcaseView) {
            $this->addContainerClass(array('bx-base-unit-showcase-wrapper'));
            $this->aCurrent['paginate']['perPage'] = $this->getItemPerPageInShowCase();
            $this->oModule->_oTemplate->addCss(array(BX_DIRECTORY_PATH_PLUGINS_PUBLIC . 'flickity/|flickity.css'));
            $this->oModule->_oTemplate->addJs(array('flickity/flickity.pkgd.min.js','modules/base/general/js/|showcase.js'));
        }

        return parent::displayResultBlock();
    }

    function displaySearchBox ($sContent, $sPaginate = '')
    {
        $aResult = parent::displaySearchBox($sContent, $sPaginate);

        if(isset($this->_aParams['filters']) && is_array($this->_aParams['filters']))
            $aResult['buttons'] = [
                ['title' => _t('_Filters'), 'href' => 'javascript:void(0)', 'onclick' => 'javascript:' . $this->_aParams['filters']['onclick']]
            ];

        return $aResult;
    }

    function applyContainerId()
    {
        if(empty($this->aCurrent['name']) || empty($this->_sMode))
            return parent::applyContainerId();

        return str_replace('_', '-', $this->aCurrent['name'] . '-search-result-block-' . $this->_sMode);
    }

    function decodeDataAPI($a, $sMethod = 'getDataAPI')
    {
        if(!is_array($a))
            return $a;

        $bExtendedUnits = getParam('sys_api_extended_units') == 'on';

        foreach($a as $i => $r)
            $a[$i] = $this->oModule->$sMethod($r, ['extended' => $bExtendedUnits]);

        return $a;
    }

    protected function _updateCurrentForFollowedContexts($sMode, $aParams, &$oProfileContext)
    {
        $CNF = &$this->oModule->_oConfig->CNF;

        if(empty($aParams['followed_contexts']))
            return false;

        $iProfileId = (int)$aParams['followed_contexts'];
        $aContextTypes = array_keys(bx_srv('system', 'get_modules_by_type', ['context', ['name_as_key' => true]]));
        $aContextIds = BxDolConnection::getObjectInstance('sys_profiles_subscriptions')->getConnectedContentByType($iProfileId, $aContextTypes);

        $this->aCurrent['restriction']['context'] = [
            'value' => array_map(function($iValue) {
                return -$iValue;
            }, $aContextIds),
            'field' => $CNF['FIELD_ALLOW_VIEW_TO'],
            'operator' => 'in',
        ];

        if(!empty($aParams['per_page']))
            $this->aCurrent['paginate']['perPage'] = is_numeric($aParams['per_page']) ? (int)$aParams['per_page'] : (int)getParam($aParams['per_page']);

        $this->sBrowseUrl = '';
        $this->aCurrent['title'] = '';
        unset($this->aCurrent['rss']);

        return true;
    }

    function _getPseudFromParam ()
    {
        $mixedPseud = getParam($this->getModuleName() . '_browse_pseud');
        if(empty($mixedPseud))
            return false;

        if(($aPseud = json_decode($mixedPseud, true)) !== null)
            return $aPseud;

        return false;
    }
}

/** @} */