StEP 3348, closes #3348

Closes #3348

Merge request studip/studip!2275

1 files changed, 148 insertions, 6 deletions

diff --git a/lib/models/LtiTool.php b/lib/models/LtiTool.php
index 53be2bc..066df46 100644
--- a/lib/models/LtiTool.php
+++ b/lib/models/LtiTool.php
@@ -1,4 +1,7 @@
 <?php
+
+use OAT\Library\Lti1p3Core\Tool\Tool;
+
 /**
  * LtiTool.php - LTI consumer API for Stud.IP
  *
@@ -16,13 +19,23 @@
  * @property string $consumer_key database column
  * @property string $consumer_secret database column
  * @property string $custom_parameters database column
+ * @property string $lti_version database column
+ * @property string $oidc_init_url database column
+ * @property string $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 $data_protection_notes database column
+ * @property string $range_id 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 SimpleORMapCollection|LtiData[] $links has_many LtiData
+ * @property SimpleORMapCollection|LtiDeployment[] $links has_many LtiData
  */
 
 class LtiTool extends SimpleORMap
@@ -32,22 +45,151 @@ class LtiTool extends SimpleORMap
      */
     protected static function configure($config = [])
     {
-        $config['db_table'] = 'lti_tool';
+        $config['db_table'] = 'lti_tools';
 
         $config['has_many']['links'] = [
-            'class_name'        => LtiData::class,
+            '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);
     }
 
     /**
-     * Find all entries.
+     * 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 static function findAll()
+    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
     {
-        return self::findBySQL('1 ORDER BY name');
+        if ($this->lti_version === '1.3a') {
+            return '1.3a';
+        } elseif ($this->lti_version === '1.1') {
+            return '1.0/1.1';
+        } else {
+            return _('unbekannt');
+        }
     }
 }