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
|
<?php
use OAT\Library\Lti1p3Core\Tool\Tool;
/**
* LtiTool.php - LTI consumer API for Stud.IP
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of
* the License, or (at your option) any later version.
*
* @author Elmar Ludwig
* @license http://www.gnu.org/licenses/gpl-2.0.html GPL version 2
*
* @property int $id database column
* @property string $name database column
* @property string $launch_url database column
* @property string $consumer_key database column
* @property string $consumer_secret database column
* @property string $custom_parameters database column
* @property int $allow_custom_url database column
* @property int $deep_linking database column
* @property int $send_lis_person database column
* @property int $mkdate database column
* @property int $chdate database column
* @property string $oauth_signature_method database column
* @property string $lti_version database column
* @property string $range_id database column
* @property string $oidc_init_url database column
* @property int|null $oauth2_client_id database column
* @property string $jwks_url database column
* @property string $jwks_key_id database column
* @property string $deep_linking_url database column
* @property string $terms_of_use_url database column
* @property string $privacy_policy_url database column
* @property string|null $data_protection_notes database column
* @property SimpleORMapCollection<LtiDeployment> $links has_many LtiDeployment
* @property Studip\OAuth2\Models\Client|null $oauth2_client has_one Studip\OAuth2\Models\Client
*/
class LtiTool extends SimpleORMap
{
/**
* Configure the database mapping.
*/
protected static function configure($config = [])
{
$config['db_table'] = 'lti_tools';
$config['has_many']['deployments'] = [ //formerly: links
'class_name' => LtiDeployment::class,
'assoc_foreign_key' => 'tool_id',
'on_delete' => 'delete'
];
$config['has_one']['oauth2_client'] = [
'class_name' => \Studip\OAuth2\Models\Client::class,
'foreign_key' => 'oauth2_client_id',
'on_delete' => 'delete'
];
parent::configure($config);
}
/**
* Validates the data in the LtiTool instance.
*
* @return string[] An array with errors. The array is empty if all
* fields are filled with valid data.
*/
public function validate() : array
{
$errors = [];
if (!$this->name) {
$errors[] = _('Es wurde kein Name angegeben.');
}
if (!$this->launch_url) {
$errors[] = _('Es wurde keine Launch-URL angegeben.');
}
if (!in_array($this->lti_version, ['1.1', '1.3a'])) {
$errors[] = _('Die ausgewählte LTI-Version ist ungültig.');
}
if ($this->lti_version === '1.1') {
if (!$this->consumer_key) {
$errors[] = _('Es wurde kein Consumer-Key angegeben.');
}
if (!$this->consumer_secret) {
$errors[] = _('Es wurde kein Consumer-Secret angegeben.');
}
}
return $errors;
}
/**
* Retrieves all LTI tools.
*
* @param bool $with_private_tools Whether to include all private tools (true)
* or not (false). Defautls to false.
*
* @return array A list of all LTI tools.
*/
public static function findAll(bool $with_private_tools = false) : array
{
if ($with_private_tools) {
return self::findBySQL("1 ORDER BY name");
} else {
return self::findBySQL("`range_id` = 'global' ORDER BY name");
}
}
/**
* Checks whether a user may have the permissions to edit the tool.
*
* @param string $user_id The ID of the user whose edit permissions shall be checked.
*
* @return bool True, if the user may edit the tool, false otherwise.
*/
public function isEditableByUser(string $user_id = null) : bool
{
$user_id ??= User::findCurrent()->id;
return $this->range_id === 'global' && $GLOBALS['perm']->have_perm('root')
|| ($this->range_id !== 'global' && $GLOBALS['perm']->have_studip_perm('tutor', $this->range_id));
}
//ToolInterface implementation
public function getToolData() : Tool
{
return new Tool(
$this->id,
$this->name,
$this->launch_url,
$this->oidc_init_url,
$this->launch_url,
$this->deep_linking_url
);
}
/**
* Retrieves the keyring of the LTI tool or generates one, if explicitly requested.
*
* @param bool $generate Generates a new keyring for the tool if set to true.
* Defaults to false.
*
* @return Keyring|null The keyring for the tool or null if no such keyring exists.
*/
public function getKeyring(bool $generate = false) : ?Keyring
{
$keyring = Keyring::findOneBySQL(
"`range_type` = 'lti_tool' AND `range_id` = :tool_id",
['tool_id' => $this->id]
);
if ($generate && !$keyring) {
$keyring = Keyring::generate($this->id, 'lti_tool');
}
return $keyring;
}
/**
* Sets or updates the public key for the LTI tool.
*
* @param string $public_key The public key to set.
*
* @return bool True, if the public key could be set, false otherwise.
*/
public function updatePublicKey(string $public_key) : bool
{
if (!$public_key) {
//No key? Then it cannot be set.
return false;
}
$keyring = $this->getKeyring();
if ($keyring) {
//Clear the fields for the passphrase and the private key:
$keyring->passphrase = '';
$keyring->private_key = '';
//Store the new public key for the tool:
$keyring->public_key = $public_key;
} else {
$keyring = Keyring::createFromPublicKey($public_key, 'lti_tool', $this->id);
}
return $keyring->store() !== false;
}
public function getLtiVersionString() : string
{
if ($this->lti_version === '1.3a') {
return '1.3a';
} elseif ($this->lti_version === '1.1') {
return '1.0/1.1';
} else {
return _('unbekannt');
}
}
}
|
