class.ilAwarenessUserCollector.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2014 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilAwarenessUserCollector
{
        protected static $instances = array();
        protected static $online_users = false;
        protected static $online_user_ids = array();

        protected $collection;
        protected $collections;
        protected $user_id;
        protected $ref_id;

        protected function __construct($a_user_id)
        {
                $this->user_id = $a_user_id;
        }

        function setRefId($a_val)
        {
                $this->ref_id = $a_val;
        }
        
        function getRefId()
        {
                return $this->ref_id;
        }

        static function getInstance($a_user_id)
        {
                if (!isset(self::$instances[$a_user_id]))
                {
                        self::$instances[$a_user_id] = new ilAwarenessUserCollector($a_user_id);
                }

                return self::$instances[$a_user_id];
        }

        static function getOnlineUsers()
        {
                if (self::$online_users === false)
                {
                        self::$online_user_ids = array();
                        include_once("./Services/User/classes/class.ilObjUser.php");
                        self::$online_users = ilObjUser::_getUsersOnline();
                        foreach (self::$online_users as $u)
                        {
                                self::$online_user_ids[] = $u["user_id"];
                        }
                }
                return self::$online_users;
        }


        public function collectUsers($a_online_only = false)
        {
                global $rbacreview;

                $this->collections = array();

                $awrn_logger = ilLoggerFactory::getLogger('awrn');

                self::getOnlineUsers();
                include_once("./Services/Awareness/classes/class.ilAwarenessUserProviderFactory.php");
                $all_users = array();
                foreach (ilAwarenessUserProviderFactory::getAllProviders() as $prov)
                {
                        // overall collection of users
                        include_once("./Services/Awareness/classes/class.ilAwarenessUserCollection.php");
                        $collection = ilAwarenessUserCollection::getInstance();

                        if ($prov->getActivationMode() != ilAwarenessUserProvider::MODE_INACTIVE)
                        {
                                $prov->setUserId($this->user_id);
                                $prov->setRefId($this->ref_id);
                                $prov->setOnlineUserFilter(false);
                                if ($prov->getActivationMode() == ilAwarenessUserProvider::MODE_ONLINE_ONLY || $a_online_only)
                                {
                                        $prov->setOnlineUserFilter(self::$online_user_ids);
                                }

                                $coll = $prov->collectUsers();
                                foreach ($coll->getUsers() as $user_id)
                                {
                                        // filter out the anonymous user
                                        if ($user_id == ANONYMOUS_USER_ID)
                                        {
                                                continue;
                                        }

                                        $awrn_logger->debug("AwarenessUserCollector: Current User: ".$this->user_id.", ".
                                                "Provider: ".$prov->getProviderId().", Collected User: ".$user_id);

                                        // cross check online, filter out offline users (if necessary)
                                        if ((!$a_online_only && $prov->getActivationMode() == ilAwarenessUserProvider::MODE_INCL_OFFLINE)
                                                || in_array($user_id, self::$online_user_ids))
                                        {
                                                $collection->addUser($user_id);
                                                if (!in_array($user_id, $all_users))
                                                {
                                                        $all_users[] = $user_id;
                                                }
                                        }
                                }
                        }
                        $this->collections[] = array(
                                "uc_title" => $prov->getTitle(),
                                "highlighted" => $prov->isHighlighted(),
                                "collection" => $collection
                        );
                }

                $remove_users = array();

                // remove all users that hide their online status
                foreach (ilObjUser::getUserSubsetByPreferenceValue($all_users, "hide_own_online_status", "y") as $u)
                {
                        $remove_users[] = $u;
                }

                // remove all users that have not accepted the terms of service yet
                require_once 'Services/TermsOfService/classes/class.ilTermsOfServiceHelper.php';
                if (ilTermsOfServiceHelper::isEnabled())
                {
                        foreach (ilObjUser::getUsersAgreed(false, $all_users) as $u)
                        {
                                if ($u != SYSTEM_USER_ID && !$rbacreview->isAssigned($u, SYSTEM_ROLE_ID))
                                //if ($u != SYSTEM_USER_ID)
                                {
                                        $remove_users[] = $u;
                                }
                        }
                }

                $this->removeUsersFromCollections($remove_users);

                return $this->collections;
        }

        protected function removeUsersFromCollections($a_remove_users)
        {
                foreach ($this->collections as $c)
                {
                        reset($a_remove_users);
                        foreach ($a_remove_users as $u)
                        {
                                $c["collection"]->removeUser($u);
                        }
                }
        }

}

?>