ChShoutBoxModule.php

Go to the documentation of this file.

<?php
 
ch_import('ChWsbModuleDb');
ch_import('ChWsbModule');
 
class ChShoutBoxModule extends ChWsbModule
{
    var $sModuleName;
 
    // contain some module information ;
    var $aModuleInfo;
 
    // contain path for current module;
    var $sPathToModule;
 
    // contain logged member's Id;
    var $iMemberId;
 
    // contain all used templates
    var $aUsedTemplates = array();
 
    // shoutbox objects
    var $_aObjects = array();
 
    function __construct(&$aModule)
    {
        parent::__construct($aModule);
 
        // prepare the location link ;
        $this->sPathToModule = CH_WSB_URL_ROOT . $this->_oConfig->getBaseUri();
        $this->sModuleName   = 'ch_' . $aModule['uri'];
        $this->aModuleInfo   = $aModule;
        $this->iMemberId     = getLoggedId();
        $this->_aObjects     = $this->_oDb->getShoutboxObjects();
    }
 
    function actionWriteMessage($sObject, $iHandler)
    {
        if ($this->_checkObjectAndHandler($sObject, $iHandler) && $this->isShoutBoxAllowed($sObject, $iHandler,
                $this->iMemberId, true)
        ) {
 
            $sMessage = isset($_POST['message'])
                ? htmlentities($_POST['message'], ENT_COMPAT, 'UTF-8', false)
                : '';
 
            if ($sMessage) {
                // create new message;
                $iMessage = $this->_oDb->writeMessage($sObject, $iHandler, $sMessage, $this->iMemberId, sprintf("%u", ip2long(getVisitorIP())));
                if($iMessage !== false) {
                    $oAlert = new ChWsbAlerts($this -> sModuleName, 'add', $iMessage, $this -> iMemberId, array('Object' => $sObject, 'Message' => $sMessage));
                    $oAlert->alert();
                }
 
                if (1 == rand(1, 10) && $this->_oConfig->iAllowedMessagesCount) { // "sometimes" delete old messages
                    // delete superfluous messages;
                    $iMessagesCount = $this->_oDb->getMessagesCount($sObject, $iHandler);
                    if ($iMessagesCount > $this->_oConfig->iAllowedMessagesCount) {
                        $this->_oDb->deleteMessages($sObject, $iHandler,
                            $iMessagesCount - $this->_oConfig->iAllowedMessagesCount);
                    }
                }
            } else {
                echo _t('_ch_shoutbox_message_empty');
            }
        } else {
            echo _t('_ch_shoutbox_access_denied');
        }
    }
 
    function actionBlockMessage($sObject, $iHandler, $iMessageId = 0)
    {
        $sCallBackMessage = '';
        $iMessageId       = (int)$iMessageId;
 
        //check membership level
        if ($this->_checkObjectAndHandler($sObject, $iHandler) && $this->isShoutBoxBlockIpAllowed($sObject, $iHandler,
                $this->iMemberId) && $iMessageId > 0
        ) {
            //get message info
            $aMessageInfo = $this->_oDb->getMessageInfo($sObject, $iHandler, $iMessageId);
            if (!$aMessageInfo) {
                $sCallBackMessage = _t('_Error Occured');
            } else {
                //block user IP
                ch_block_ip((int)$aMessageInfo['IP'], $this->_oConfig->iBlockExpirationSec,
                    _t('_ch_shoutbox_ip_blocked'));
 
                $this->_oDb->deleteMessagesByIp($sObject, $iHandler, $aMessageInfo['IP']);
            }
        } else {
            $sCallBackMessage = _t('_ch_shoutbox_access_denied');
        }
 
        echo $sCallBackMessage;
    }
 
    function actionDeleteMessage($sObject, $iHandler, $iMessageId = 0)
    {
        $sCallBackMessage = '';
        $iMessageId       = (int)$iMessageId;
 
        //check membership level
        if ($this->_checkObjectAndHandler($sObject, $iHandler) && $this->isShoutBoxDeleteAllowed($sObject, $iHandler,
                $this->iMemberId) && $iMessageId > 0
        ) {
            if ($this->_oDb->deleteMessage($sObject, $iHandler, $iMessageId)) {
                $this->isShoutBoxDeleteAllowed($sObject, $iHandler, $this->iMemberId, true);
            } else {
                $sCallBackMessage = _t('_Error Occured');
            }
        } else {
            $sCallBackMessage = _t('_ch_shoutbox_access_denied');
        }
 
        echo $sCallBackMessage;
    }
 
    function actionGetMessages($sObject, $iHandler, $iLastMessageId = 0)
    {
        $iLastMessageId = (int)$iLastMessageId;
        $aRetArray      = array();
 
        if ($this->_checkObjectAndHandler($sObject, $iHandler)) {
            $sMessages      = $this->_getLastMessages($sObject, $iHandler, $iLastMessageId);
            $iLastMessageId = $this->_oDb->getLastMessageId($sObject, $iHandler);
 
            $aRetArray = array(
                'messages'        => $sMessages,
                'last_message_id' => $iLastMessageId,
            );
        }
 
        echo json_encode($aRetArray);
    }
 
    function actionAdministration()
    {
        $GLOBALS['iAdminPage'] = 1;
 
        if (!isAdmin()) {
            header('location: ' . CH_WSB_URL_ROOT);
        }
 
        $aLanguageKeys = array(
            'settings' => _t('_ch_shoutbox_settings'),
        );
 
        // try to define globals category number;
        $iId = $this->_oDb->getSettingsCategory('shoutbox_update_time');
        if (!$iId) {
            $sContent = MsgBox(_t('_Empty'));
        } else {
            ch_import('ChWsbAdminSettings');
 
            $mixedResult = '';
            if (isset($_POST['save']) && isset($_POST['cat'])) {
                $oSettings   = new ChWsbAdminSettings($iId);
                $mixedResult = $oSettings->saveChanges($_POST);
            }
 
            $oSettings = new ChWsbAdminSettings($iId);
            $sResult   = $oSettings->getForm();
 
            if ($mixedResult !== true && !empty($mixedResult)) {
                $sResult = $mixedResult . $sResult;
            }
 
            $sContent = $GLOBALS['oAdmTemplate']
                ->parseHtmlByName('design_box_content.html', array('content' => $sResult));
        }
 
        $this->_oTemplate->pageCodeAdminStart();
        echo $this->_oTemplate->adminBlock($sContent, $aLanguageKeys['settings']);
        $this->_oTemplate->pageCodeAdmin(_t('_ch_shoutbox_module'));
    }
 
    function serviceGetShoutBox($sObject = 'ch_shoutbox', $iHandler = 0)
    {
        if (!$this->_checkObjectAndHandler($sObject, $iHandler)) {
            $sObject = 'ch_shoutbox';
        }
 
        echo $this->_oTemplate->getShoutboxWindow($sObject, $iHandler, $this->sPathToModule
            , $this->_oDb->getLastMessageId($sObject, $iHandler), $this->_getLastMessages($sObject, $iHandler));
    }
 
    function serviceResponseProfileDelete($oAlert)
    {
        if (!($iProfileId = (int)$oAlert->iObject)) {
            return false;
        }
 
        $this->_oDb->deleteMessagesByProfile((int)$iProfileId);
 
        return true;
    }
 
    function serviceUpdateObjects($sModuleUri = 'all', $bInstall = true)
    {
        $aModules = $sModuleUri == 'all' ? $this->_oDb->getModules() : array($this->_oDb->getModuleByUri($sModuleUri));
 
        foreach ($aModules as $aModule) {
            if (!ChWsbRequest::serviceExists($aModule, 'get_shoutbox_data')) {
                continue;
            }
 
            if (!($aData = ChWsbService::call($aModule['uri'], 'get_shoutbox_data'))) {
                continue;
            }
 
            if ($bInstall) {
                $this->_oDb->insertData($aData);
            } else {
                $this->_oDb->deleteData($aData);
            }
        }
 
        $this->_oDb->clearShoutboxObjectsCache();
    }
 
    function _getLastMessages($sObject, $iHandler, $iLastId = 0)
    {
        return $this->_oTemplate->getProcessedMessages($this->_oDb->getMessages($sObject, $iHandler, $iLastId)
            , $this->isShoutBoxDeleteAllowed($sObject, $iHandler, $this->iMemberId)
            , $this->isShoutBoxBlockIpAllowed($sObject, $iHandler, $this->iMemberId));
    }
 
    function _defineActions()
    {
        defineMembershipActions(
            array('shoutbox use', 'shoutbox delete messages', 'shoutbox block by ip')
        );
    }
 
    function isShoutBoxAllowed($sObject, $iHandler, $iMemberId, $isPerformAction = false)
    {
        if (isAdmin()) {
            return true;
        }
 
        if ($this->_aObjects[$sObject]['code_allow_use']) {
            return $this->_runCheckAllowedCustom($sObject, $iHandler, $iMemberId, $isPerformAction,
                $this->_aObjects[$sObject]['code_allow_use']);
        }
 
        if (!defined('CH_SHOUTBOX_USE')) {
            $this->_defineActions();
        }
 
        $aCheck = checkAction($iMemberId, CH_SHOUTBOX_USE, $isPerformAction);
 
        return $aCheck[CHECK_ACTION_RESULT] == CHECK_ACTION_RESULT_ALLOWED;
    }
 
    function isShoutBoxDeleteAllowed($sObject, $iHandler, $iMemberId, $isPerformAction = false)
    {
        if (isAdmin()) {
            return true;
        }
 
        if ($this->_aObjects[$sObject]['code_allow_delete']) {
            return $this->_runCheckAllowedCustom($sObject, $iHandler, $iMemberId, $isPerformAction,
                $this->_aObjects[$sObject]['code_allow_delete']);
        }
 
        if (!defined('CH_SHOUTBOX_DELETE_MESSAGES')) {
            $this->_defineActions();
        }
 
        $aCheck = checkAction($iMemberId, CH_SHOUTBOX_DELETE_MESSAGES, $isPerformAction);
 
        return $aCheck[CHECK_ACTION_RESULT] == CHECK_ACTION_RESULT_ALLOWED;
    }
 
    function isShoutBoxBlockIpAllowed($sObject, $iHandler, $iMemberId, $isPerformAction = false)
    {
        if (isAdmin()) {
            return true;
        }
 
        if ($this->_aObjects[$sObject]['code_allow_block']) {
            return $this->_runCheckAllowedCustom($sObject, $iHandler, $iMemberId, $isPerformAction,
                $this->_aObjects[$sObject]['code_allow_block']);
        }
 
 
        if (!defined('CH_SHOUTBOX_BLOCK_BY_IP')) {
            $this->_defineActions();
        }
 
        $aCheck = checkAction($iMemberId, CH_SHOUTBOX_BLOCK_BY_IP, $isPerformAction);
 
        return $aCheck[CHECK_ACTION_RESULT] == CHECK_ACTION_RESULT_ALLOWED;
    }
 
    function _checkObjectAndHandler($sObject, &$iHandler)
    {
        $iHandler = (int)$iHandler;
 
        return isset($this->_aObjects[$sObject]);
    }
 
    function _runCheckAllowedCustom($sObject, $iHandler, $iMemberId, $isPerformAction, $sCode)
    {
        return eval($sCode);
    }
}