smtech / see-all-submissions

submissions.php

<?php

require_once 'common.inc.php';

use smtech\ReflexiveCanvasLTI\LTI\ToolProvider;
use Battis\DataUtilities;

/**
 * This is a quasi temporary "unborking" while a few support tickets are
 * working through the queue. See the fix-me notations below.
 *
 * @param string $previewUrl
 * @return string
 */
function unborkPreviewUrl($previewUrl)
{
    if (!preg_match('%^https?://.*%', $previewUrl)) {
        /*

40% of this comment could be valid code. Did you maybe forget this after debugging?

         * FIXME: per [case 01584858 ](https://cases.canvaslms.com/CommunityConsole?id=500A000000UPwauIAD) attachments are not well-documented and the Crocodoc attachments include an incomplete preview URL that works… but not in an IFRAME
         */
        return $_SESSION[CANVAS_INSTANCE_URL] . $previewUrl;
    } elseif (preg_match('%^(.*version=)(\d+)(.*)$%', $previewUrl, $match)) {
        /*

43% of this comment could be valid code. Did you maybe forget this after debugging?

         * FIXME: per [case 01584819](https://cases.canvaslms.com/CommunityConsole?id=500A000000UPwSlIAL) preview URLs are generated "off by one" and are really zero-indexed.
         */
        return $match[1] . ($match[2] - 1) . $match[3];
    } else {
        /* whatevs, it is what it is… */
        return $previewUrl;
    }
}

$enrollments = $toolbox->api_get(
    'courses/' . $_SESSION[ToolProvider::class]['canvas']['course_id'] . '/enrollments',
    [
        'user_id' => $_SESSION[ToolProvider::class]['canvas']['user_id']
    ]
);

$isStudent = false;
foreach ($enrollments as $enrollment) {
    if ($enrollment['type'] == 'StudentEnrollment') {
        $isStudent = true;
    }
    if (empty($user)) {
        $user = $enrollment['user'];
    }
}

$assignments = [];
if ($isStudent) {
    $submissions = $toolbox->api_get(
        'courses/' . $_SESSION[ToolProvider::class]['canvas']['course_id'] . '/students/submissions',
        [
            'as_user_id' => $user['id'],
            'student_ids' => [$user['id']],
            'include' => ['submission_history']
        ]
    );

    foreach ($submissions as $submission) {
        $assignment = $toolbox->api_get(
            'courses/' . $_SESSION[ToolProvider::class]['canvas']['course_id'] . "/assignments/{$submission['assignment_id']}"
        );
        if (!in_array('not_graded', $assignment['submission_types'])) {
            $assignmentData['assignment'] = $assignment;
            foreach($submission['submission_history'] as $version) {
                if (!empty($version['submitted_at'])) {
                    $versionData = [
                        'id' => $version['id'],
                        'attempt' => $version['attempt'],
                        'submitted_at' => $version['submitted_at']
                    ];
                    if ($version['submission_type'] == 'online_text_entry') {
                        $versionData['body'] = $version['body'];
                    } else {
                        if (empty($version['attachments'])) {
                            $versionData['type'] = DataUtilities::titleCase(str_replace('_', ' ', $version['submission_type']));
                            $versionData['preview_url'] = unborkPreviewUrl($version['preview_url']);
                        } else {
                            foreach ($version['attachments'] as $attachment) {
                                $versionData['attachments'][$attachment['id']] = [
                                        'name' => $attachment['display_name'],
                                        'preview_url' => unborkPreviewUrl($attachment['preview_url'])
                                    ];
                            }
                        }
                    }
                    if (!empty($versionData['body']) || !empty($versionData['preview_url']) || !empty($versionData['attachments'])) {
                        $assignmentData['submissions'][$versionData['attempt']] = $versionData;
                    }
                }
            }
            if (!empty($assignmentData['submissions'])) {
                $assignments[$submission['assignment_id']] = $assignmentData;
            }
            unset($assignmentData);
            unset($versionData);
        }
    }
}

$toolbox->smarty_assign([
    'name' => 'See All Submissions',
    'category' => $user['name'],
    'assignments' => $assignments,
]);
if (empty($assignments)) {
    $toolbox->smarty_display('no_submissions.tpl');
} else {
    $toolbox->smarty_display('submissions.tpl');
}