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
|
<?php
namespace JsonApi\Routes\Courses;
use Psr\Http\Message\ServerRequestInterface as Request;
use Psr\Http\Message\ResponseInterface as Response;
use JsonApi\Errors\AuthorizationFailedException;
use JsonApi\Errors\BadRequestException;
use JsonApi\JsonApiController;
class CoursesIndex extends JsonApiController
{
protected $allowedFilteringParameters = ['q', 'fields', 'semester', 'category', 'scope_choose', 'range_choose', 'df'];
protected $allowedIncludePaths = [
'blubber-threads',
'end-semester',
'events',
'feedback-elements',
'file-refs',
'folders',
'forum-categories',
'institute',
'memberships',
'news',
'participating-institutes',
'sem-class',
'sem-type',
'start-semester',
'status-groups',
'wiki-pages',
];
protected $allowedPagingParameters = ['offset', 'limit'];
/**
* @SuppressWarnings(PHPMD.UnusedFormalParameters)
*/
public function __invoke(Request $request, Response $response, $args)
{
if (!Authority::canIndexCourses($user = $this->getUser($request))) {
throw new AuthorizationFailedException();
}
if ($error = $this->validateFilters()) {
throw new BadRequestException($error);
}
$courseIds = $this->searchCourses($user, $this->getContextFilters());
list($offset, $limit) = $this->getOffsetAndLimit();
return $this->getPaginatedContentResponse(
$this->getCourses(array_slice($courseIds, $offset, $limit)),
count($courseIds)
);
}
private function validateFilters()
{
$filtering = $this->getQueryParameters()->getFilteringParameters() ?: [];
// keyword aka q
if (isset($filtering['q']) && mb_strlen($filtering['q']) < 3) {
return 'Search term too short.';
}
// fields
if (isset($filtering['fields'])) {
$validFields = ['all', 'title_lecturer_number', 'title', 'sub_title', 'lecturer', 'number', 'comment', 'scope'];
if (!in_array($filtering['fields'], $validFields)) {
return 'Filter "fields" has to be one of: '.join(', ', $validFields);
}
}
// semester
if (isset($filtering['semester'])) {
$semester = \Semester::find($filtering['semester']);
if (!$semester) {
return 'Invalid "semester".';
}
}
// data fields
if (isset($filtering['df']) && is_array($filtering['df'])) {
$accepted_dfs = $this->getAcceptedDataFields();
foreach (array_keys($filtering['df']) as $df) {
if (!in_array($df, $accepted_dfs)) {
return 'Invalid data field as filtering parameter.';
}
}
}
}
private function getContextFilters()
{
$defaults = [
'q' => '%%%',
'fields' => 'all', // Titel, Lehrende...
'semester' => 'all', // Semester
'category' => null, // SEM_CLASS
'scope_choose' => null, // Studienbereiche
'range_choose' => null, // Einrichtungen,
'combination' => 'OR', // OR|AND
];
$filtering = $this->getQueryParameters()->getFilteringParameters() ?: [];
return array_merge($defaults, $filtering);
}
private function getCourses(array $course_ids): array
{
$filtering = $this->getQueryParameters()->getFilteringParameters() ?: [];
if (isset($filtering['df']) && is_array($filtering['df'])) {
$df_where = [];
$params = [
$course_ids
];
foreach ($filtering['df'] as $id => $value) {
$df_where[] = ' (`datafields_entries`.`datafield_id` = ? AND `datafields_entries`.`content` = ?) ';
$params[] = $id;
$params[] = $value;
}
return \Course::findBySQL("JOIN `datafields_entries`
ON `seminare`.`seminar_id` = `datafields_entries`.`range_id`
WHERE `seminare`.`seminar_id` IN (?)
AND " .
implode('AND', $df_where),
$params);
} else {
return \Course::findMany($course_ids);
}
}
/**
* Get ids of accepted datafields for current user.
* Only simple types of bool, textline, selectbox and radio with global
* visibility for all users are accepted.
*
* @return array
*/
private function getAcceptedDataFields(): array
{
$data_fields = \DataField::findAndMapBySQL(
fn(\DataField $data_field) => $data_field->id,
"`object_type` = 'sem' AND `view_perms` = 'user'
AND `type` IN('bool', 'textline', 'selectbox', 'radio')"
);
return $data_fields;
}
/**
* @SuppressWarnings(PHPMD.Superglobals)
*/
private function searchCourses(\User $user, array $filters)
{
$visibleOnly = !(is_object($GLOBALS['perm'])
&& $GLOBALS['perm']->have_perm(\Config::Get()->SEM_VISIBILITY_PERM, $user->id));
$searchHelper = new \StudipSemSearchHelper();
$searchHelper->setParams(
[
'quick_search' => $filters['q'],
'qs_choose' => $filters['fields'],
'sem' => $filters['semester'],
'category' => $filters['category'],
'scope_choose' => $filters['scope_choose'],
'range_choose' => $filters['range_choose'],
],
$visibleOnly
);
return $searchHelper->doSearch();
}
}
|
