class.ilBuddySystemGUI.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2015 ILIAS open source, Extended GPL, see docs/LICENSE */

require_once 'Services/JSON/classes/class.ilJsonUtil.php';
require_once 'Services/Contact/BuddySystem/exceptions/class.ilBuddySystemException.php';

class ilBuddySystemGUI
{
        const BS_REQUEST_HTTP_GET  = 1;
        const BS_REQUEST_HTTP_POST = 2;

        protected static $frontend_initialized = false;

        protected $ctrl;

        protected $buddylist;

        protected $statefactory;

        protected $user;

        protected $lng;

        public function __construct()
        {
                global $ilCtrl, $ilUser, $lng;

                $this->ctrl = $ilCtrl;
                $this->user = $ilUser;
                $this->lng  = $lng;

                require_once 'Services/Contact/BuddySystem/classes/class.ilBuddyList.php';
                require_once 'Services/Contact/BuddySystem/classes/states/class.ilBuddySystemRelationStateFactory.php';
                $this->buddylist     = ilBuddyList::getInstanceByGlobalUser();
                $this->statefactory  = ilBuddySystemRelationStateFactory::getInstance();

                $this->lng->loadLanguageModule('buddysystem');
        }

        public static function initializeFrontend()
        {
                global $tpl, $ilCtrl, $lng;

                if(!self::$frontend_initialized)
                {
                        $lng->loadLanguageModule('buddysystem');

                        require_once 'Services/JSON/classes/class.ilJsonUtil.php';

                        $tpl->addJavascript('./Services/Contact/BuddySystem/js/buddy_system.js');

                        $config = new stdClass();
                        $config->http_post_url        = $ilCtrl->getFormActionByClass(array('ilUIPluginRouterGUI', 'ilBuddySystemGUI'), '', '', true, false);
                        $config->transition_state_cmd = 'transitionAsync';
                        $tpl->addOnLoadCode("il.BuddySystem.setConfig(".ilJsonUtil::encode($config).");");

                        $btn_config = new stdClass();
                        $btn_config->bnt_class = 'ilBuddySystemLinkWidget';

                        $tpl->addOnLoadCode("il.BuddySystemButton.setConfig(".ilJsonUtil::encode($btn_config).");");
                        $tpl->addOnLoadCode("il.BuddySystemButton.init();");

                        self::$frontend_initialized = true;
                }
        }

        public function executeCommand()
        {
                if($this->user->isAnonymous())
                {
                        throw new RuntimeException('This controller only accepts requests of logged in users');
                }

                $next_class = $this->ctrl->getNextClass($this);
                $cmd        = $this->ctrl->getCmd();

                switch($next_class)
                {
                        default:
                                $cmd .= 'Command';
                                $this->$cmd();
                                break;
                }
        }

        protected function isRequestParameterGiven($key, $type)
        {
                switch($type)
                {
                        case self::BS_REQUEST_HTTP_POST:
                                return isset($_POST[$key]) && strlen($_POST[$key]);
                                break;

                        case self::BS_REQUEST_HTTP_GET:
                        default:
                                return isset($_GET[$key]) && strlen($_GET[$key]);
                                break;
                }
        }

        private function requestCommand()
        {
                $this->transitionCommand('request', 'buddy_relation_requested', function(ilBuddySystemRelation $relation) {
                        if($relation->isUnlinked() && !ilUtil::yn2tf(ilObjUser::_lookupPref($relation->getBuddyUserId(), 'bs_allow_to_contact_me')))
                        {
                                throw new ilException("The requested user does not want to get contact requests");
                        }
                });
        }

        private function ignoreCommand()
        {
                $this->transitionCommand('ignore', 'buddy_request_ignored');
        }

        private function linkCommand()
        {
                $this->transitionCommand('link', 'buddy_request_approved');
        }

        private function transitionCommand($cmd, $positive_feedback_lng_id, callable $onBeforeExecute = null)
        {
                if(!$this->isRequestParameterGiven('user_id', self::BS_REQUEST_HTTP_GET))
                {
                        ilUtil::sendInfo($this->lng->txt('buddy_bs_action_not_possible'), true);
                        $this->ctrl->returnToParent($this);
                }

                try
                {
                        require_once 'Services/Contact/BuddySystem/classes/class.ilBuddyList.php';
                        $relation = ilBuddyList::getInstanceByGlobalUser()->getRelationByUserId((int)$_GET['user_id']);

                        if(null !== $onBeforeExecute)
                        {
                                $onBeforeExecute($relation);
                        }

                        ilBuddyList::getInstanceByGlobalUser()->$cmd($relation);
                        ilUtil::sendSuccess($this->lng->txt($positive_feedback_lng_id), true);

                }
                catch(ilBuddySystemRelationStateAlreadyGivenException $e)
                {
                        ilUtil::sendInfo(sprintf($this->lng->txt($e->getMessage()), ilObjUser::_lookupLogin((int)$_GET['user_id'])), true);
                }
                catch(ilBuddySystemRelationStateTransitionException $e)
                {
                        ilUtil::sendInfo(sprintf($this->lng->txt($e->getMessage()), ilObjUser::_lookupLogin((int)$_GET['user_id'])), true);
                }
                catch(ilException $e)
                {
                        ilUtil::sendInfo($this->lng->txt('buddy_bs_action_not_possible'), true);
                }

                $this->ctrl->returnToParent($this);
        }

        private function transitionAsyncCommand()
        {
                global $lng;

                if(!$this->ctrl->isAsynch())
                {
                        throw new RuntimeException('This action only supports AJAX http requests');
                }

                if(!isset($_POST['usr_id']) || !is_numeric($_POST['usr_id']))
                {
                        throw new RuntimeException('Missing "usr_id" parameter');
                }

                if(!isset($_POST['action']) || !strlen($_POST['action']))
                {
                        throw new RuntimeException('Missing "action" parameter');
                }

                $response = new stdClass();
                $response->success = false;

                try
                {
                        $usr_id = (int)$_POST['usr_id'];
                        $action = ilUtil::stripSlashes($_POST['action']);

                        if(ilObjUser::_isAnonymous($usr_id))
                        {
                                throw new ilBuddySystemException(sprintf("You cannot perform a state transition for the anonymous user (id: %s)", $usr_id));
                        }

                        if(!strlen(ilObjUser::_lookupLogin($usr_id)))
                        {
                                throw new ilBuddySystemException(sprintf("You cannot perform a state transition for a non existing user (id: %s)", $usr_id));
                        }

                        $relation = $this->buddylist->getRelationByUserId($usr_id);

                        // The ILIAS JF decided to add a new personal setting 
                        if($relation->isUnlinked() && !ilUtil::yn2tf(ilObjUser::_lookupPref($relation->getBuddyUserId(), 'bs_allow_to_contact_me')))
                        {
                                throw new ilException("The requested user does not want to get contact requests");
                        }

                        try
                        {
                                $this->buddylist->{$action}($relation);
                                $response->success = true;
                        }
                        catch(ilBuddySystemRelationStateAlreadyGivenException $e)
                        {
                                $response->message = sprintf($this->lng->txt($e->getMessage()), ilObjUser::_lookupLogin((int)$usr_id));
                        }
                        catch(ilBuddySystemRelationStateTransitionException $e)
                        {
                                $response->message = sprintf($this->lng->txt($e->getMessage()), ilObjUser::_lookupLogin((int)$usr_id));
                        }
                        catch(Exception $e)
                        {
                                $response->message = $lng->txt('buddy_bs_action_not_possible');
                        }

                        $response->state      = get_class($relation->getState());
                        $response->state_html = $this->statefactory->getRendererByOwnerAndRelation($this->buddylist->getOwnerId(), $relation)->getHtml();
                }
                catch(Exception $e)
                {
                        $response->message = $lng->txt('buddy_bs_action_not_possible');
                }

                echo json_encode($response);
                exit();
        }
}