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
|
<?php
namespace JsonApi\Routes\Courseware\Rel;
use Courseware\Bookmark;
use Courseware\Instance;
use Courseware\StructuralElement;
use JsonApi\Errors\BadRequestException;
use JsonApi\Errors\ConflictException;
use JsonApi\Errors\RecordNotFoundException;
use JsonApi\Routes\Courseware\Authority;
use JsonApi\Routes\Courseware\CoursewareInstancesHelper;
use JsonApi\Routes\RelationshipsController;
use Psr\Http\Message\ServerRequestInterface as Request;
class BookmarkedStructuralElements extends RelationshipsController
{
use CoursewareInstancesHelper;
protected $allowedPagingParameters = ['offset', 'limit'];
/**
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
protected function fetchRelationship(Request $request, $related)
{
$bookmarks = $related->getUsersBookmarks($this->getUser($request));
$total = count($bookmarks);
list($offset, $limit) = $this->getOffsetAndLimit();
return $this->getPaginatedIdentifiersResponse(array_slice($bookmarks, $offset, $limit), $total);
}
protected function replaceRelationship(Request $request, $related)
{
$json = $this->validate($request);
$structuralElements = $this->validateStructuralElements($user = $this->getUser($request), $json, $related);
$this->replaceBookmarks($user, $related, $structuralElements);
return $this->getCodeResponse(204);
}
protected function addToRelationship(Request $request, $related)
{
$json = $this->validate($request);
$structuralElements = $this->validateStructuralElements($user = $this->getUser($request), $json, $related);
$this->addBookmarks($user, $structuralElements);
return $this->getCodeResponse(204);
}
protected function removeFromRelationship(Request $request, $related)
{
$json = $this->validate($request);
$structuralElements = $this->validateStructuralElements($user = $this->getUser($request), $json, $related);
$this->removeBookmarks($user, $structuralElements);
return $this->getCodeResponse(204);
}
protected function findRelated(array $args)
{
if (!($related = $this->findInstance($args['id']))) {
throw new RecordNotFoundException();
}
return $related;
}
protected function authorize(Request $request, $resource)
{
switch ($request->getMethod()) {
case 'GET':
return Authority::canIndexBookmarks($this->getUser($request), $resource);
case 'DELETE':
case 'PATCH':
case 'POST':
return Authority::canUpdateBookmarks($this->getUser($request), $resource);
default:
return false;
}
}
/**
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
protected function getRelationshipSelfLink($resource, $schema, $userData)
{
return $schema->getRelationshipSelfLink($resource, \JsonApi\Schemas\Courseware\Instance::REL_BOOKMARKS);
}
/**
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
protected function getRelationshipRelatedLink($resource, $schema, $userData)
{
return $schema->getRelationshipRelatedLink($resource, \JsonApi\Schemas\Courseware\Instance::REL_BOOKMARKS);
}
protected function validateResourceDocument($json, $data)
{
if (!self::arrayHas($json, 'data')) {
return 'Missing `data` member at document´s top level.';
}
$data = self::arrayGet($json, 'data');
if (!is_array($data)) {
return 'Document´s ´data´ must be an array.';
}
foreach ($data as $item) {
if (\JsonApi\Schemas\Courseware\StructuralElement::TYPE !== self::arrayGet($item, 'type')) {
return 'Wrong `type` in document´s `data`.';
}
if (!self::arrayGet($item, 'id')) {
return 'Missing `id` of document´s `data`.';
}
}
if (self::arrayHas($json, 'data.attributes')) {
return 'Document must not have `attributes`.';
}
}
private function validateStructuralElements(\User $user, $json, Instance $instance)
{
$structuralElements = [];
$root = $instance->getRoot();
foreach (self::arrayGet($json, 'data') as $structuralElementResource) {
if (!($structuralElement = StructuralElement::find($structuralElementResource['id']))) {
throw new RecordNotFoundException();
}
if (!Authority::canShowStructuralElement($user, $structuralElement)) {
throw new RecordNotFoundException();
}
if (
$root->range_id != $structuralElement->range_id ||
$root->range_type != $structuralElement->range_type
) {
throw new BadRequestException('Mismatching ranges of bookmarks to related resource.');
}
$structuralElements[] = $structuralElement->id;
}
return $structuralElements;
}
private function replaceBookmarks(\User $user, Instance $instance, array $newIds)
{
$oldBookmarks = $instance->getUsersBookmarks($user);
$oldIds = array_map(function ($element) {
return $element->id;
}, $oldBookmarks);
$onlyInOld = array_diff($oldIds, $newIds);
$onlyInNew = array_diff($newIds, $oldIds);
$this->removeBookmarks($user, $onlyInOld);
$this->addBookmarks($user, $onlyInNew);
}
private function addBookmarks(\User $user, array $newIds): void
{
foreach ($newIds as $structuralElementId) {
if (Bookmark::countBySQL('user_id = ? AND element_id = ?', [$user->id, $structuralElementId])) {
continue;
}
Bookmark::create(['user_id' => $user->id, 'element_id' => $structuralElementId]);
}
}
private function removeBookmarks(\User $user, array $oldIds): void
{
Bookmark::deleteBySQL('user_id = ? AND element_id IN (?)', [$user->id, $oldIds]);
}
}
|
