CanvasApi.php

Go to the documentation of this file.

<?php

namespace ceLTIc\LTI\ApiHook\canvas;

use ceLTIc\LTI\UserResult;
use ceLTIc\LTI\HttpMessage;

trait CanvasApi
{

    private static $DEFAULT_PER_PAGE = 50;

    private $domain = null;

    private $token = null;

    private $courseId = null;

    private $sourceObject = null;

    private function get($withGroups)
    {
        $consumer = $this->sourceObject->getConsumer();
        $this->domain = $consumer->getSetting('canvas.domain');
        $this->token = $consumer->getSetting('canvas.token');
        $this->courseId = $this->sourceObject->getSetting('custom_canvas_course_id');
        $perPage = $consumer->getSetting('canvas.per_page', strval(self::$DEFAULT_PER_PAGE));
        if (!is_numeric($perPage)) {
            $perPage = self::$DEFAULT_PER_PAGE;
        }
        $prefix = $consumer->getSetting('canvas.group_set_prefix');
        if ($this->domain && $this->token && $this->courseId) {
            if ($withGroups) {
                $this->setGroupSets($perPage, $prefix);
            }
            $users = $this->getUsers($perPage, $withGroups);
            if ($withGroups) {
                $this->setGroups($perPage, $users);
            }
        } else {
            $users = false;
        }

        return $users;
    }

    private function setGroupSets($perPage, $prefix)
    {
        $this->sourceObject->groupSets = array();
        $url = "https://{$this->domain}/api/v1/courses/{$this->courseId}/group_categories";
        if ($perPage > 0) {
            $url .= "?per_page={$perPage}";
        }
        do {
            $http = new HttpMessage($url, 'GET', null, "Authorization: Bearer {$this->token}");
            $http->send();
            if ($http->ok) {
                $allCategories = json_decode($http->response);
                $http->ok = !is_null($allCategories) && is_array($allCategories);
            }
            $url = '';
            if ($http->ok) {
                foreach ($allCategories as $category) {
                    if (empty($prefix) || (strpos($category->name, $prefix) === 0)) {
                        $this->sourceObject->groupSets[strval($category->id)] = array('title' => $category->name, 'groups' => array(),
                            'num_members' => 0, 'num_staff' => 0, 'num_learners' => 0);
                    }
                }
                if (preg_match('/<([^>]+)>; *rel=\"next\"/', $http->responseHeaders, $matches)) {
                    $url = $matches[1];
                }
            }
        } while ($url);
    }

    private function getRoles($perPage)
    {
        $roles = array();

        $url = "https://{$this->domain}/api/v1/courses/{$this->courseId}/enrollments?state[]=invited&state[]=active&state[]=completed";
        if ($perPage > 0) {
            $url .= "&per_page={$perPage}";
        }
        do {
            $http = new HttpMessage($url, 'GET', null, "Authorization: Bearer {$this->token}");
            $http->send();
            if ($http->ok) {
                $enrolments = json_decode($http->response);
                $http->ok = !is_null($enrolments) && is_array($enrolments);
            }
            $url = '';
            if ($http->ok) {
                foreach ($enrolments as $enrolment) {
                    $roles[strval($enrolment->user_id)] = $enrolment->type;
                }
                if (preg_match('/<([^>]+)>; *rel=\"next\"/', $http->responseHeaders, $matches)) {
                    $url = $matches[1];
                }
            } else {
                $roles = false;
            }
        } while ($url);

        return $roles;
    }

    private function getUsers($perPage, $withGroups)
    {
        $users = array();

        $url = "https://{$this->domain}/api/v1/courses/{$this->courseId}/users?state[]=invited&state[]=active&state[]=completed";
        if ($perPage > 0) {
            $url .= "&per_page={$perPage}";
        }
        if ($withGroups) {
            $url .= '&include[]=group_ids';
        }
        $roles = $this->getRoles($perPage);
        do {
            $http = new HttpMessage($url, 'GET', null, "Authorization: Bearer {$this->token}");
            $http->send();
            if ($http->ok) {
                $enrolments = json_decode($http->response);
                $http->ok = !is_null($enrolments) && is_array($enrolments);
            }
            $url = '';
            if ($http->ok) {
                foreach ($enrolments as $enrolment) {
                    $userId = strval($enrolment->id);
                    if (array_key_exists($userId, $users)) {
                        $user = $users[$userId];
                    } else {
                        if (is_a($this->sourceObject, 'ceLTIc\LTI\ResourceLink')) {
                            $user = UserResult::fromResourceLink($this->sourceObject, $userId);
                        } else {
                            $user = new UserResult();
                            $user->ltiUserId = $userId;
                        }
                    }
                    $user->setNames('', '', $enrolment->name);
                    $user->setEmail($enrolment->email, $this->sourceObject->getConsumer()->defaultEmail);
                    if (!empty($enrolment->group_ids)) {
                        foreach ($enrolment->group_ids as $groupId) {
                            $user->groups[] = strval($groupId);
                        }
                    }
                    if (array_key_exists($userId, $roles)) {
                        switch ($roles[$userId]) {
                            case 'StudentEnrollment':
                                $user->roles[] = 'urn:lti:role:ims/lis/Learner';
                                break;
                            case 'TeacherEnrollment':
                                $user->roles[] = 'urn:lti:role:ims/lis/Instructor';
                                break;
                            case 'TaEnrollment':
                                $user->roles[] = 'urn:lti:role:ims/lis/TeachingAssistant';
                                break;
                            case 'DesignerEnrollment':
                                $user->roles[] = 'urn:lti:role:ims/lis/ContentDeveloper';
                                break;
                            case 'ObserverEnrollment':
                                $user->roles[] = 'urn:lti:instrole:ims/lis/Observer';
                                $user->roles[] = 'urn:lti:role:ims/lis/Mentor';
                                break;
                        }
                    }
                    $users[$userId] = $user;
                }
                if (preg_match('/<([^>]+)>; *rel=\"next\"/', $http->responseHeaders, $matches)) {
                    $url = $matches[1];
                }
            } else {
                $users = false;
            }
        } while ($url);

        return $users;
    }

    private function setGroups($perPage, $users)
    {
        $this->sourceObject->groups = array();
        $url = "https://{$this->domain}/api/v1/courses/{$this->courseId}/groups";
        if ($perPage > 0) {
            $url .= "?per_page={$perPage}";
        }
        do {
            $http = new HttpMessage($url, 'GET', null, "Authorization: Bearer {$this->token}");
            $http->send();
            if ($http->ok) {
                $allGroups = json_decode($http->response);
                $http->ok = !is_null($allGroups) && is_array($allGroups);
            }
            $url = '';
            if ($http->ok) {
                foreach ($allGroups as $group) {
                    $setId = strval($group->group_category_id);
                    if (array_key_exists($setId, $this->sourceObject->groupSets)) {
                        $groupId = strval($group->id);
                        $this->sourceObject->groups[$groupId] = array('title' => $group->name, 'set' => $setId);
                        foreach ($users as $user) {
                            if (in_array($groupId, $user->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'] ++;
                                }
                                if (!in_array($groupId, $this->sourceObject->groupSets[$setId]['groups'])) {
                                    $this->sourceObject->groupSets[$setId]['groups'][] = $groupId;
                                }
                            }
                        }
                    }
                }
                if (preg_match('/<([^>]+)>; *rel=\"next\"/', $http->responseHeaders, $matches)) {
                    $url = $matches[1];
                }
            }
        } while ($url);
    }

}