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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
|
<?php
class Lti_ToolController extends AuthenticatedController
{
public function before_filter(&$action, &$args)
{
parent::before_filter($action, $args);
$this->tool = null;
$this->deployment = null;
$this->tool_id = '';
$this->range_id = '';
if (in_array($action, ['index', 'add', 'edit', 'delete'])) {
$this->range_id = $args[0];
$this->tool_id = $args[1] ?? '';
if ($action === 'add' && !$this->tool_id) {
$this->tool = new LtiTool();
$this->tool->range_id = $this->range_id;
} else {
if (!$this->tool_id) {
PageLayout::postError(_('Es wurde kein LTI-Tool angegeben.'));
return;
}
$this->tool = LtiTool::find($this->tool_id);
if (!$this->tool) {
throw new \Studip\Exception(_('Das angegebene LTI-Tool wurde nicht gefunden.'));
}
}
}
}
public function index_action($range_id, $tool_id): void
{
//$this->tool is created in the before-filter.
if ($this->range_id !== 'global') {
$this->deployment = LtiDeployment::findOneBySQL(
'`tool_id` = :tool_id AND `course_id` = :range_id',
['tool_id' => $this->tool->id, 'range_id' => $this->range_id]
);
}
}
public function add_action($range_id, $tool_id = ''): void
{
//NOTE: The parameters are checked and processed in the before_filter.
$this->addEditHandler();
}
public function edit_action($range_id, $tool_id): void
{
//NOTE: The parameters are checked and processed in the before_filter.
$this->addEditHandler();
}
protected function addEditHandler(): void
{
if (!$this->tool) {
return;
}
$this->deployment = null;
if ($this->tool->isNew()) {
if (!Config::get()->LTI_ALLOW_TOOL_CONFIG_IN_COURSE && $this->range_id !== 'global') {
throw new AccessDeniedException(
_('Die Einrichtung von LTI-Tools in Veranstaltungen ist ausgeschaltet.')
);
}
if ($this->tool->range_id === 'global' && !$this->tool->isEditableByUser()) {
throw new AccessDeniedException();
}
PageLayout::postWarning(_('Bitte beachten Sie das geltende europäische Datenschutzrecht (DSGVO)!'));
if ($this->tool->range_id !== 'global') {
$this->deployment = new LtiDeployment();
$this->deployment->course_id = $this->tool->range_id;
}
} elseif ($this->range_id !== 'global') {
$this->deployment = LtiDeployment::findOneBySQL(
'`tool_id` = :tool_id AND `course_id` = :range_id',
['tool_id' => $this->tool->id, 'range_id' => $this->range_id]
);
if (!$this->deployment) {
//Create a new deployment:
$this->deployment = new LtiDeployment();
$this->deployment->tool_id = $this->tool->id;
$this->deployment->course_id = $this->range_id;
}
}
if (Request::isPost()) {
$this->saveTool();
}
}
/**
* Handles the saving of a tool.
*/
protected function saveTool(): void
{
CSRFProtection::verifyUnsafeRequest();
if ($this->range_id === 'global') {
//The admin page for editing global tools.
$this->tool->name = trim(Request::get('name'));
$this->tool->launch_url = trim(Request::get('launch_url'));
} else {
//The page for editing tools configured in courses.
$this->deployment->title = trim(Request::get('name'));
$this->deployment->description = trim(Request::get('description'));
$this->deployment->launch_url = trim(Request::get('launch_url'));
$document_target = trim(Request::get('document_target'));
if ($document_target === 'iframe') {
if (!is_array($this->deployment->options)) {
$this->deployment->options = [];
}
$this->deployment->options['document_target'] = $document_target;
} elseif (isset($this->deployment->options['document_target'])) {
unset($this->deployment->options['document_target']);
}
}
//If a deployment is present, the tool is not used in the global context.
//If a tool is not used in the global context and the range_id is not set to "global",
//it is a tool that is only used for one course.
if (
!$this->deployment
|| $this->tool->range_id !== 'global'
|| $GLOBALS['perm']->have_perm('root')
) {
$this->tool->name = trim(Request::get('name'));
$this->tool->launch_url = trim(Request::get('launch_url'));
$this->tool->terms_of_use_url = trim(Request::get('terms_of_use_url'));
$this->tool->privacy_policy_url = trim(Request::get('privacy_policy_url'));
$this->tool->data_protection_notes = trim(Request::get('data_protection_notes'));
$this->tool->lti_version = Request::get('lti_version', '1.3a');
if ($this->tool->lti_version === '1.3a') {
$this->tool->oauth_signature_method = 'sha256';
$this->tool->oidc_init_url = trim(Request::get('oidc_init_url'));
$this->tool->jwks_url = trim(Request::get('jwks_url'));
$this->tool->jwks_key_id = trim(Request::get('jwks_key_id'));
$this->tool->deep_linking_url = trim(Request::get('deep_linking_url'));
$this->tool->deep_linking = (bool) $this->tool->deep_linking_url;
} else {
//LTI 1.0/1.1:
$this->tool->oauth_signature_method = 'sha1';
$this->tool->consumer_key = trim(Request::get('consumer_key'));
$this->tool->consumer_secret = trim(Request::get('consumer_secret'));
}
$this->tool->send_lis_person = Request::int('send_lis_person', 0);
$this->tool->custom_parameters = trim(Request::get('custom_parameters'));
$tool_public_key = trim(Request::get('tool_public_key'));
$errors = $this->tool->validate();
if ($errors) {
PageLayout::postError(
_('Die folgenden Daten zum LTI-Tool sind fehlerhaft:'),
array_map('htmlReady', $errors)
);
return;
}
if ($this->tool->lti_version === '1.3a' && !$tool_public_key && !$this->tool->jwks_url) {
PageLayout::postError(
_('Es wurde weder ein öffentlicher Schlüssel noch eine JWKS-URL zum Tool angegeben.')
);
return;
}
if ($this->tool->store() !== false) {
if ($this->deployment) {
$this->deployment->tool_id = $this->tool->id;
}
} else {
PageLayout::postError(_('Das LTI-Tool konnte nicht gespeichert werden.'));
return;
}
}
if ($this->deployment) {
$this->deployment->store();
}
if ($this->tool->lti_version === '1.3a' && $tool_public_key) {
if (!$this->tool->updatePublicKey($tool_public_key)) {
PageLayout::postError(
_('Der öffentliche Schlüssel des LTI-Tools konnte nicht gespeichert werden.')
);
}
}
PageLayout::postSuccess(_('Das LTI-Tool wurde gespeichert.'));
if (Request::isDialog()) {
$this->response->add_header('X-Dialog-Close', '1');
$this->render_nothing();
} elseif ($this->range_id === 'global') {
$this->redirect('admin/lti');
} else {
$this->redirect('course/lti');
}
}
public function delete_action($range_id, $tool_id): void
{
//NOTE: The parameters are checked and processed in the before_filter.
CSRFProtection::verifyUnsafeRequest();
$deleted = false;
$tool_name = $this->tool->name;
if ($this->tool->range_id === 'global') {
if ($range_id === 'global') {
$deleted = $this->tool->delete();
} else {
//A tool shall be deleted from a course: Delete the deployment instead.
$deployment = LtiDeployment::findOneBySQL(
"`tool_id` = :tool_id AND `course_id` = :course_id",
['tool_id' => $this->tool->id, 'course_id' => $range_id]
);
if ($deployment) {
$tool_name = $deployment->title;
$deleted = $deployment->delete();
} else {
PageLayout::postError(sprintf(_('Das LTI-Tool „%s“ ist in dieser Veranstaltung nicht vorhanden.'), htmlReady($this->tool->name)));
return;
}
}
} else {
//Delete the tool directly:
$deleted = $this->tool->delete();
}
if ($deleted !== false) {
PageLayout::postSuccess(sprintf(_('Das LTI-Tool „%s“ wurde gelöscht.'), htmlReady($tool_name)));
} else {
PageLayout::postError(_('Das LTI-Tool „%s“ konnte nicht gelöscht werden.'), htmlReady($tool_name));
}
if ($range_id === 'global') {
//Redirect to the admin overview page.
$this->redirect('admin/lti');
} elseif (Course::exists($range_id)) {
//Redirect to the LTI module of the course:
$this->redirect('course/lti', ['cid' => $range_id]);
}
}
}
|
