MoodleApi.php

<?php
 
namespace ceLTIc\LTI\ApiHook\moodle;
 
use ceLTIc\LTI\UserResult;
use ceLTIc\LTI\Http\HttpMessage;
use ceLTIc\LTI\Util;
 
trait MoodleApi
{
 
    private static $DEFAULT_PER_PAGE = 50;
 
    private $url = null;
 
    private $token = null;
 
    private $courseId = null;
 
    private $sourceObject = null;
 
    public function isConfigured()
    {
        $platform = $this->sourceObject->getPlatform();
 
        return !empty($platform->getSetting('moodle.url')) && !empty($platform->getSetting('moodle.token'));
    }
 
    private function get($withGroups)
    {
        $platform = $this->sourceObject->getPlatform();
        $this->url = $platform->getSetting('moodle.url');
        $this->token = $platform->getSetting('moodle.token');
        $perPage = $platform->getSetting('moodle.per_page', '');
        if (!is_numeric($perPage)) {
            $perPage = self::$DEFAULT_PER_PAGE;
        } else {
            $perPage = intval($perPage);
        }
        $prefix = $platform->getSetting('moodle.grouping_prefix');
        if ($this->url && $this->token && $this->courseId) {
            if ($withGroups) {
                $this->setGroupings($prefix);
            }
            $users = $this->getUsers($perPage, $withGroups);
            if ($users && $withGroups) {
                $this->setGroups($users);
            }
        } else {
            $users = false;
        }
 
        return $users;
    }
 
    private function setGroupings($prefix)
    {
        $ok = false;
        $this->sourceObject->groupSets = array();
        $this->sourceObject->groups = array();
        $params = array(
            'courseid' => $this->courseId
        );
        $courseGroupings = $this->callMoodleApi('core_group_get_course_groupings', $params);
        if (is_array($courseGroupings)) {
            $groupingIds = array_map(function($grouping) {
                return $grouping->id;
            }, $courseGroupings);
            if (empty($groupingIds)) {
                $ok = true;
            } else {
                $params = array(
                    'groupingids' => $groupingIds,
                    'returngroups' => 1
                );
                $groupings = $this->callMoodleApi('core_group_get_groupings', $params);
                if (is_array($groupings)) {
                    $ok = true;
                    foreach ($groupings as $grouping) {
                        if (!empty($grouping->groups) && (empty($prefix) || (strpos($grouping->name, $prefix) === 0))) {
                            $groupingId = strval($grouping->id);
                            $this->sourceObject->groupSets[$groupingId] = array('title' => $grouping->name, 'groups' => array(),
                                'num_members' => 0, 'num_staff' => 0, 'num_learners' => 0);
                            foreach ($grouping->groups as $group) {
                                $groupId = strval($group->id);
                                $this->sourceObject->groupSets[$groupingId]['groups'][] = $groupId;
                                if (!isset($this->sourceObject->groups[$groupId])) {
                                    $this->sourceObject->groups[$groupId] = array('title' => $group->name, 'set' => $groupingId);
                                } elseif (!is_array($this->sourceObject->groups[$groupId]['set'])) {
                                    $this->sourceObject->groups[$groupId]['set'] = array($this->sourceObject->groups[$groupId]['set'], $groupingId);
                                } else {
                                    $this->sourceObject->groups[$groupId]['set'][] = $groupingId;
                                }
                            }
                        }
                    }
                }
            }
        }
 
        return $ok;
    }
 
    private function getUsers($perPage, $withGroups)
    {
        $users = array();
 
        $params = array(
            'courseid' => $this->courseId,
            'options' => array(
                array(
                    'name' => 'onlyactive',
                    'value' => 1
                ),
                array(
                    'name' => 'userfields',
                    'value' => 'id'
                ),
                array(
                    'name' => 'withcapability',
                    'value' => 'mod/lti:manage'
                )
            )
        );
        $teachers = array();
        $enrolments = $this->callMoodleApi('core_enrol_get_enrolled_users', $params);
        if (is_array($enrolments)) {
            foreach ($enrolments as $enrolment) {
                $teachers[] = $enrolment->id;
            }
        }
        $userFields = 'id, username, idnumber, firstname, lastname, fullname, email, roles';
        if ($withGroups) {
            $userFields .= ', groups';
        }
        $params = array(
            'courseid' => $this->courseId,
            'options' => array(
                array(
                    'name' => 'onlyactive',
                    'value' => 1
                ),
                array(
                    'name' => 'userfields',
                    'value' => $userFields
                )
            )
        );
        if ($perPage > 0) {
            array_push($params['options'],
                array(
                    'name' => 'limitnumber',
                    'value' => $perPage
                )
            );
        }
        $n = 0;
        do {
            if ($perPage > 0) {
                array_push($params['options'],
                    array(
                        'name' => 'limitfrom',
                        'value' => $n
                    )
                );
            }
            $enrolments = $this->callMoodleApi('core_enrol_get_enrolled_users', $params);
            if (is_array($enrolments)) {
                foreach ($enrolments as $enrolment) {
                    $userId = strval($enrolment->id);
                    if (is_a($this->sourceObject, 'ceLTIc\LTI\ResourceLink')) {
                        $user = UserResult::fromResourceLink($this->sourceObject, $userId);
                    } else {
                        $user = new UserResult();
                        $user->ltiUserId = $userId;
                    }
                    $user->setEmail($enrolment->email, $this->sourceObject->getPlatform()->defaultEmail);
                    $user->setNames($enrolment->firstname, $enrolment->lastname, $enrolment->fullname);
                    $user->username = $enrolment->username;
                    if (!empty($enrolment->idnumber)) {
                        $user->sourcedId = $enrolment->idnumber;
                    } else {
                        $user->sourcedId = null;
                    }
                    if (!empty($enrolment->groups)) {
                        foreach ($enrolment->groups as $group) {
                            $groupId = strval($group->id);
                            if (array_key_exists($groupId, $this->sourceObject->groups)) {
                                $user->groups[] = $groupId;
                            }
                        }
                    }
                    // Add Instructor or Learner role - NB no check is made for the Administrator role
                    if (in_array($enrolment->id, $teachers)) {
                        $user->roles[] = 'urn:lti:role:ims/lis/Instructor';
                    } else {
                        $user->roles[] = 'urn:lti:role:ims/lis/Learner';
                    }
                    $users[$userId] = $user;
                }
                if ($perPage > 0) {
                    $n += count($enrolments);
                    array_pop($params['options']);
                }
            } else {
                $users = false;
                break;
            }
        } while (is_array($enrolments) && !empty($enrolments));
 
        return $users;
    }
 
    private function setGroups($users)
    {
        foreach ($users as $user) {
            $sets = array();
            foreach ($user->groups as $group) {
                if (array_key_exists($group, $this->sourceObject->groups) && !empty($this->sourceObject->groups[$group]['set'])) {
                    $setIds = $this->sourceObject->groups[$group]['set'];
                    if (!is_array($setIds)) {
                        $setIds = array($setIds);
                    }
                    foreach ($setIds as $setId) {
                        // Check that user is not a member of another group in the same grouping
                        if (in_array($setId, $sets)) {
                            // Remove groups but leave grouping as empty to acknowledge its existence in the platform
                            foreach ($this->sourceObject->groupSets[$setId]['groups'] as $groupId) {
                                if (!is_array($this->sourceObject->groups[$groupId]['set']) && ($this->sourceObject->groups[$groupId]['set'] === $setId)) {
                                    unset($this->sourceObject->groups[$groupId]['set']);
                                } else if (is_array($this->sourceObject->groups[$groupId]['set']) && in_array($setId,
                                        $this->sourceObject->groups[$groupId]['set'])) {
                                    $pos = array_search($setId, $this->sourceObject->groups[$groupId]['set']);
                                    unset($this->sourceObject->groups[$groupId]['set'][$pos]);
                                    if (empty($this->sourceObject->groups[$groupId]['set'])) {
                                        unset($this->sourceObject->groups[$groupId]['set']);
                                    }
                                }
                            }
                        } elseif (array_key_exists($group, $this->sourceObject->groups)) {
                            $this->sourceObject->groupSets[$setId]['num_members']++;
                            if ($user->isStaff()) {
                                $this->sourceObject->groupSets[$setId]['num_staff']++;
                            }
                            if ($user->isLearner()) {
                                $this->sourceObject->groupSets[$setId]['num_learners']++;
                            }
                            $sets[] = $setId;
                        }
                    }
                }
            }
        }
    }
 
    private function callMoodleApi($method, $params)
    {
        $json = null;
        $serviceUrl = $this->url . '/webservice/rest/server.php';
        $params = array_merge(array(
            'wstoken' => $this->token,
            'wsfunction' => $method,
            'moodlewsrestformat' => 'json'
            ), $params);
        $http = new HttpMessage($serviceUrl, 'POST', $params);
        $http->send();
        if ($http->ok) {
            $json = Util::jsonDecode($http->response);
            $http->ok = !is_null($json) && is_array($json);
            if (!$http->ok) {
                Util::logError("Moodle web service returned an error: {$http->response}");
            }
        }
 
        return $json;
    }
 
}