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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
|
<?php
namespace JsonApi\Routes\Courseware;
use JsonApi\NonJsonApiController;
use Courseware\Instance;
use Courseware\StructuralElement;
use Courseware\Unit;
use Courseware\UserProgress;
use JsonApi\Errors\AuthorizationFailedException;
use JsonApi\Errors\BadRequestException;
use JsonApi\Errors\RecordNotFoundException;
use JsonApi\Errors\UnprocessableEntityException;
use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request;
/**
* Displays the progress of a user for a unit
*
* @author Ron Lucke <lucke@elan-ev.de>
* @license GPL2 or any later version
*
* @since Stud.IP 5.3
*/
class UserProgressesOfUnitsShow extends NonJsonApiController
{
public function __invoke(Request $request, Response $response, array $args)
{
$user = $this->getUser($request);
$unit = Unit::find($args['id']);
if (!$unit) {
throw new RecordNotFoundException();
}
$root = $unit->structural_element;
if (!$GLOBALS['perm']->have_studip_perm('autor', $root->range_id) || !$unit->canRead($user)) {
throw new AuthorizationFailedException();
}
$instance = new Instance($root);
$isTeacher = $GLOBALS['perm']->have_studip_perm('tutor', $root->range_id);
$elements = $this->findElements($instance, $user);
$progress = $this->computeSelfProgresses($instance, $user, $elements, $isTeacher);
$progress = $this->computeCumulativeProgresses($instance, $elements, $progress);
$progresses = $this->prepareProgressData($elements, $progress);
$response = $response->withHeader('Content-Type', 'application/json');
$response->getBody()->write((string) json_encode($progresses));
return $response;
}
private function findElements(Instance $instance, \User $user): iterable
{
$elements = $instance->getRoot()->findDescendants($user);
$elements[] = $instance->getRoot();
return array_combine(array_column($elements, 'id'), $elements);
}
private function computeSelfProgresses(
Instance $instance,
\User $user,
iterable &$elements,
bool $showProgressForAllParticipants
): iterable
{
$progress = [];
/** @var \Course $course */
$course = $instance->getRange();
$allBlockIds = $instance->findAllBlocksGroupedByStructuralElementId(function ($row) {
return $row['id'];
});
$courseMemberIds = $showProgressForAllParticipants
? array_column($course->getMembersWithStatus('autor'), 'user_id')
: [$user->getId()];
$sql = "SELECT block_id, COUNT(grade) AS count, SUM(grade) AS grade
FROM cw_user_progresses
WHERE block_id IN (?) AND user_id IN (?)
GROUP BY block_id";
$userProgresses = \DBManager::get()->fetchGrouped($sql, [$allBlockIds, $courseMemberIds]);
foreach ($elements as $elementId => $element) {
$selfProgress = $this->getSelfProgresses($allBlockIds, $elementId, $userProgresses, $courseMemberIds);
$progress[$elementId] = [
'self' => $selfProgress['counter'] ? $selfProgress['progress'] / $selfProgress['counter'] : 1,
];
}
return $progress;
}
private function getSelfProgresses(
array $allBlockIds,
string $elementId,
array $userProgresses,
array $courseMemberIds
): array {
$blks = $allBlockIds[$elementId] ?? [];
if (count($blks) === 0) {
return [
'counter' => 0,
'progress' => 1,
];
}
$data = [
'counter' => count($blks),
'progress' => 0,
];
$usersCounter = count($courseMemberIds);
foreach ($blks as $blk) {
$progresses = $userProgresses[$blk];
$usersProgress = $progresses['count'] ? (float) $progresses['grade'] : 0;
$data['progress'] += $usersCounter > 0 ? $usersProgress / $usersCounter : 0;
}
return $data;
}
private function computeCumulativeProgresses(Instance $instance, iterable &$elements, iterable &$progress): iterable
{
$childrenOf = $this->computeChildrenOf($elements);
// compute `cumulative` of each element
$visitor = function (&$progress, $element) use (&$childrenOf, &$elements, &$visitor) {
$elementId = $element->getId();
$numberOfNodes = 0;
$cumulative = 0;
// visit children first
if (isset($childrenOf[$elementId])) {
foreach ($childrenOf[$elementId] as $childId) {
$visitor($progress, $elements[$childId]);
$numberOfNodes += $progress[$childId]['numberOfNodes'];
$cumulative += $progress[$childId]['cumulative'];
}
}
$progress[$elementId]['cumulative'] = $cumulative + $progress[$elementId]['self'];
$progress[$elementId]['numberOfNodes'] = $numberOfNodes + 1;
return $progress;
};
$visitor($progress, $instance->getRoot());
return $progress;
}
private function computeChildrenOf(iterable &$elements): iterable
{
$childrenOf = [];
foreach ($elements as $elementId => $element) {
if ($element['parent_id']) {
if (!isset($childrenOf[$element['parent_id']])) {
$childrenOf[$element['parent_id']] = [];
}
$childrenOf[$element['parent_id']][] = $elementId;
}
}
return $childrenOf;
}
private function prepareProgressData(iterable &$elements, iterable &$progress): iterable
{
$data = [];
foreach ($elements as $elementId => $element) {
$elementProgress = $progress[$elementId];
$cumulative = $elementProgress['cumulative'] / $elementProgress['numberOfNodes'];
$data[$elementId] = [
'id' => (int) $elementId,
'parent_id' => (int) $element['parent_id'],
'name' => $element['title'],
'progress' => [
'cumulative' => round($cumulative, 2) * 100,
'self' => round($elementProgress['self'], 2) * 100,
],
];
}
return $data;
}
}
|
