aboutsummaryrefslogtreecommitdiff
path: root/lib/classes/JsonApi/Routes/Courseware/TasksIndex.php
blob: 995243741ffd9c5260b0b9b1f20d804dbd55f6a9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
<?php

namespace JsonApi\Routes\Courseware;

use Courseware\Task;
use Courseware\TaskGroup;
use JsonApi\Errors\AuthorizationFailedException;
use JsonApi\Errors\BadRequestException;
use JsonApi\JsonApiController;
use JsonApi\Schemas\Courseware\Task as TaskSchema;
use JsonApi\Schemas\Courseware\TaskGroup as TaskGroupSchema;
use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request;

/**
 * Displays all Tasks.
 */
class TasksIndex extends JsonApiController
{
    protected $allowedFilteringParameters = ['cid'];

    protected $allowedIncludePaths = [
        TaskSchema::REL_FEEDBACK,
        TaskSchema::REL_SOLVER,
        TaskSchema::REL_STRUCTURAL_ELEMENT,
        TaskSchema::REL_TASK_GROUP,
        TaskSchema::REL_TASK_GROUP . '.' . TaskGroupSchema::REL_LECTURER,
        TaskSchema::REL_TASK_GROUP . '.' . TaskGroupSchema::REL_PEER_REVIEW_PROCESSES,
    ];

    /**
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     *
     * @param array $args
     *
     * @return Response
     */
    public function __invoke(Request $request, Response $response, $args)
    {
        if ($error = $this->validateFilters()) {
            throw new BadRequestException($error);
        }

        $filtering = $this->getQueryParameters()->getFilteringParameters() ?: [];
        $resources = [];

        if (empty($filtering)) {
            if (!Authority::canIndexTasks($this->getUser($request))) {
                throw new AuthorizationFailedException('Only root users may index all tasks without a `filter[cid]`.');
            }

            $resources = Task::findBySQL('1 ORDER BY mkdate', []);
        } else {
            $user = $this->getUser($request);
            /** @var ?\Course $course */
            $course = \Course::find($filtering['cid']);

            if ($GLOBALS['perm']->have_studip_perm('tutor', $course->getId(), $user->getId())) {
                $resources = $this->findTasksByCourse($course);
            } else {
                $resources = $this->findTasksByCourseMember($user, $course);
            }
        }

        return $this->getContentResponse($resources);
    }

    private function validateFilters()
    {
        $filtering = $this->getQueryParameters()->getFilteringParameters() ?: [];

        // course
        if (isset($filtering['cid'])) {
            $course = \Course::find($filtering['cid']);
            if (!$course) {
                return 'Could not find a course matching this `filter[cid]`.';
            }
        }
    }

    private function findTasksByCourse(\Course $course, bool $showNotYetActive = true): \SimpleCollection
    {
        $whereClause = $showNotYetActive ? 'seminar_id = ?' : 'start_date <= UNIX_TIMESTAMP() AND seminar_id = ?';
        $taskGroups = TaskGroup::findBySQL($whereClause, [$course->getId()]);

        $tasks = [];
        foreach ($taskGroups as $taskGroup) {
            $tasks[] = $taskGroup->tasks->getArrayCopy();
        }
        $tasks = \SimpleORMapCollection::createFromArray(array_flatten($tasks), false)->orderBy('id asc');

        return $tasks;
    }

    private function findTasksByCourseMember(\User $user, \Course $course): \SimpleCollection
    {
        $groupIds = $course['statusgruppen']
            ->filter(function (\Statusgruppen $group) use ($user) {
                return $group->isMember($user->getId());
            })
            ->pluck('id');

        return $this->findTasksByCourse($course, false)->filter(function ($task) use ($user, $groupIds) {
            return ('autor' === $task['solver_type'] && $task['solver_id'] === $user->getId()) ||
                ('group' === $task['solver_type'] && in_array($task['solver_id'], $groupIds));
        });
    }
}