Merge branch 'main' into issue-3911issue-3911

1 files changed, 371 insertions, 0 deletions

diff --git a/lib/ilias_interface/IliasModule.php b/lib/ilias_interface/IliasModule.php
new file mode 100644
index 0000000..f9bf958
--- /dev/null
+++ b/lib/ilias_interface/IliasModule.php
@@ -0,0 +1,371 @@
+<?php
+# Lifter007: TODO
+# Lifter003: TODO
+# Lifter010: TODO
+
+/**
+* class to handle content module data
+*
+* This class handles all data from a single ILIAS content module
+*
+* @author   Arne Schröder <schroeder@data-quest.de>
+* @access   public
+* @modulegroup  ilias_interface_modules
+* @module       IliasModule
+* @package  ILIAS-Interface
+*/
+
+class IliasModule
+{
+    public $id;
+    public $title;
+    public $description;
+    public $module_type;
+    public $module_type_name;
+    public $author;
+    public $make_date;
+    public $change_date;
+    public $path;
+    public $ilias_index;
+    public $allowed_operations;
+    public $is_offline;
+    public $is_connected;
+    public $owner;
+    public $author_studip;
+    public $siblings_count;
+    public $icon_file;
+
+    /**
+    * constructor
+    *
+    * init class
+    * @access public
+    * @param string $module_id module-id
+    * @param string $module_type module-type
+    * @param string $ilias_index ilias installation index
+    */
+    function __construct($module_id, $module_data, $ilias_index, $ilias_version)
+    {
+        $this->id = $module_id;
+        $this->title = $module_data['title'];
+        $this->description = $module_data['description'];
+        $this->ilias_index = $ilias_index;
+        $this->module_type = $module_data['type'];
+        $this->make_date = $module_data['create_date'];
+        $this->change_date = $module_data['last_update'];
+        $supported_modules = ConnectedIlias::getSupportedModuleTypes();
+        $this->module_type_name = $supported_modules[$this->module_type];
+        $this->owner = $module_data['owner'];
+        $this->author_studip = false;
+        if (is_array($module_data['references'][$module_id]['operations'])) {
+            $this->allowed_operations = $module_data['references'][$module_id]['operations'];
+        } else {
+            $this->allowed_operations = [];
+        }
+        $this->is_offline = $module_data['offline'];
+        $this->siblings_count = $module_data['ref_count'];
+    }
+
+    /**
+    * get id
+    *
+    * returns id
+    * @access public
+    * @return string id
+    */
+    function getId()
+    {
+        return $this->id;
+    }
+
+    /**
+    * get ILIAS installation index
+    *
+    * returns ILIAS installation index
+    * @access public
+    * @return string cms-type
+    */
+    function getIndex()
+    {
+        return $this->ilias_index;
+    }
+
+    /**
+    * get module-type
+    *
+    * returns module-type
+    * @access public
+    * @return string module-type
+    */
+    function getModuleType()
+    {
+        return $this->module_type;
+    }
+
+    /**
+    * get module-type name
+    *
+    * returns module-type name
+    * @access public
+    * @return string module-type name
+    */
+    function getModuleTypeName()
+    {
+        return $this->module_type_name;
+    }
+
+    /**
+    * set title
+    *
+    * sets title
+    * @access public
+    * @param string $module_title title
+    */
+    function setTitle($module_title)
+    {
+        $this->title = $module_title;
+    }
+
+    /**
+    * get title
+    *
+    * returns title
+    * @access public
+    * @return string title
+    */
+    function getTitle()
+    {
+        return $this->title;
+    }
+
+    /**
+    * set description
+    *
+    * sets description
+    * @access public
+    * @param string $module_description description
+    */
+    function setDescription($module_description)
+    {
+        $this->description = $module_description;
+    }
+
+    /**
+    * get description
+    *
+    * returns description
+    * @access public
+    * @return string description
+    */
+    function getDescription()
+    {
+        return $this->description;
+    }
+
+    /**
+     * get make date
+     *
+     * returns make date
+     * @access public
+     * @return string make date
+     */
+    function getMakeDate()
+    {
+        return $this->make_date;
+    }
+
+    /**
+     * get change date
+     *
+     * returns change date
+     * @access public
+     * @return string change date
+     */
+    function getChangeDate()
+    {
+        return $this->change_date;
+    }
+
+    /**
+     * get ILIAS path
+     *
+     * returns ILIAS path
+     * @access public
+     * @return string ILIAS path
+     */
+    function getPath()
+    {
+        return $this->path;
+    }
+
+    /**
+     * get route
+     *
+     * returns route for given action
+     * @access public
+     * @param string action start, edit, view_tools, view_course, add, remove
+     * @return string url
+     */
+    function getRoute($action = '')
+    {
+        switch ($action) {
+            case 'start'       : return 'my_ilias_accounts/redirect/'.$this->ilias_index.'/start/'.$this->id.'/'.$this->module_type;
+            case 'edit'        : return 'my_ilias_accounts/redirect/'.$this->ilias_index.'/edit/'.$this->id.'/'.$this->module_type;
+            case 'view_tools'  : return 'my_ilias_accounts/view_object/'.$this->ilias_index.'/'.$this->id;
+            case 'view_course' : return 'course/ilias_interface/view_object/'.$this->ilias_index.'/'.$this->id;
+            case 'add'         : return 'course/ilias_interface/edit_object_assignment/'.$this->ilias_index.'?add_module=1&ilias_module_id='.$this->id;
+            case 'remove'      : return 'course/ilias_interface/edit_object_assignment/'.$this->ilias_index.'?remove_module&ilias_module_id='.$this->id;
+        }
+
+        throw new InvalidArgumentException("Unknown action {$action}");
+    }
+
+
+    /**
+     * get permission status
+     *
+     * returns true if given action is allowed
+     * @access public
+     * @param string action start, edit
+     * @return boolean permission status
+     */
+    function isAllowed($action = '')
+    {
+        switch ($action) {
+            case 'start' : return in_array('read', $this->allowed_operations);
+            case 'edit' : return in_array('write', $this->allowed_operations);
+            case 'delete' : return in_array('delete', $this->allowed_operations);
+            case 'copy' : return in_array('copy', $this->allowed_operations);
+        }
+        return true;
+    }
+
+    /**
+    * set ILIAS author ID
+    *
+    * sets author
+    * @access public
+    * @param array $module_authors authors
+    */
+    function setAuthorIlias($module_author)
+    {
+        $this->owner = $module_author;
+    }
+
+    /**
+     * get ILIAS author ID
+     *
+     * returns author
+     * @access public
+     * @return string author id
+     */
+    function getAuthorIlias()
+    {
+        return $this->owner;
+    }
+
+    /**
+     * get author Stud.IP-User
+     *
+     * returns author User object
+     * @access public
+     * @return object User
+     */
+    function getAuthorStudip()
+    {
+        if (is_object($this->author_studip)) {
+            return $this->author_studip;
+        }
+
+        $query = "SELECT studip_user_id
+                  FROM auth_extern
+                  WHERE external_user_id = ? AND external_user_system_type = ?";
+        $statement = DBManager::get()->prepare($query);
+        $statement->execute([$this->owner, $this->ilias_index]);
+        $data = $statement->fetch(PDO::FETCH_ASSOC);
+        if ($data) {
+            $this->author_studip = User::find($data['studip_user_id']);
+        }
+
+        return $this->author_studip;
+    }
+
+    /**
+    * set connection
+    *
+    * sets connection with seminar
+    * @access public
+    * @param string $seminar_id seminar-id
+    * @return boolean successful
+    */
+    function setConnection($seminar_id)
+    {
+        $this->is_connected = true;
+        return IliasObjectConnections::setConnection($seminar_id, $this->id, $this->module_type, $this->ilias_index);
+    }
+
+    /**
+    * unset connection
+    *
+    * unsets connection with seminar
+    * @access public
+    * @param string $seminar_id seminar-id
+    * @return boolean successful
+    */
+    function unsetConnection($seminar_id)
+    {
+        $this->is_connected = false;
+        return IliasObjectConnections::unsetConnection($seminar_id, $this->id, $this->module_type, $this->ilias_index);
+    }
+
+    /**
+    * set connection-status
+    *
+    * sets connection-status
+    * @access public
+    * @param boolean $is_connected connection-status
+    */
+    function setConnectionType($is_connected)
+    {
+        $this->is_connected = $is_connected;
+    }
+
+    /**
+    * get connection-status
+    *
+    * returns true, if module is connected to seminar
+    * @access public
+    * @return boolean connection-status
+    */
+    function isConnected()
+    {
+        return $this->is_connected;
+    }
+
+    /**
+    * get reference string
+    *
+    * returns reference string for content-module
+    * @access public
+    * @return string reference string
+    */
+    function getReferenceString()
+    {
+        return $this->ilias_index."_".$this->module_type."_".$this->id;
+    }
+
+    /**
+    * get icon-image
+    *
+    * returns icon-image
+    * @access public
+    * @return string icon-image
+    */
+    function getIcon($mode = 'inactive')
+    {
+        if (!$this->icon_file) {
+            $this->icon_file = 'learnmodule';
+        }
+        return Icon::create($this->icon_file, 'inactive', [])->asImg();
+    }
+}