Merge branch 'feature/blocks-filter' into 'develop'

Feature MD File Blocks

See merge request ILIAS/Plugins/Community/MDViewer!4

Author: thibsy

README.md

@@ -3,6 +3,19 @@ MDViewer
 ### Description
 Display Markdown-Text from an external source such as Github-Repos.
 
+With version >=1.4.0 of this plugin, external sources can contain blocks that follow a specific syntax which is similar to the one known from `ilTemplate`. An example can be found below.
+```
+<!-- BEGIN block_name_1 -->
+...
+### My Block title
+Lorem ipsdum dolor sit amet ...
+...
+<!-- END block_name_1 -->
+```
+As you can see, the block "tags" are simple HTML-comments which are not visible when rendering the actual MD file.
+
+Of course, `block_name_1` can be replaced by the name of your choosing and wrap any content you like. Note that there is no duplicate protection though, so if multiple blocks with the same name are found, the first one will be used.
+
 ### Installation
 Start at your ILIAS root directory
 ```bash

classes/class.ilMDViewerConfig.php

@@ -9,6 +9,7 @@ class ilMDViewerConfig extends ActiveRecord
 
     const TABLE_NAME = 'md_tme_config';
     const KEY_IDS_OF_AUTHORIZED_ROLES = "ids_of_authorized_roles";
+    const KEY_MD_BLOCKS_FILTER_ACTIVE = 'md_blocks_filter_active';
 
     /**
      * @return string

classes/class.ilMDViewerConfigGUI.php

@@ -12,6 +12,23 @@ class ilMDViewerConfigGUI extends ilPluginConfigGUI
     const CMD_CONFIGURE = 'configure';
     const CMD_SAVE = 'save';
     const CMD_CANCEL = 'cancel';
+
+    /**
+     * @var \ILIAS\DI\HTTPServices
+     */
+    protected $http;
+    /**
+     * @var \ILIAS\DI\RBACServices
+     */
+    protected $rbac;
+    /**
+     * @var ilMDViewerPlugin
+     */
+    protected $plugin;
+    /**
+     * @var \ILIAS\DI\UIServices
+     */
+    protected $ui;
     /**
      * @var ilCtrl
      */
@@ -24,10 +41,6 @@ class ilMDViewerConfigGUI extends ilPluginConfigGUI
      * @var ilTemplate
      */
     protected $tpl;
-    /**
-     * @var ilPropertyFormGUI
-     */
-    private $config_form;
 
     /**
      * ilMDViewerConfigGUI constructor.
@@ -39,6 +52,10 @@ public function __construct()
         $this->ctrl = $DIC->ctrl();
         $this->lng = $DIC->language();
         $this->tpl = $DIC->ui()->mainTemplate();
+        $this->http = $DIC->http();
+        $this->rbac = $DIC->rbac();
+        $this->plugin = $this->getPluginObject() ?? (new ilMDViewerPlugin());
+        $this->ui = $DIC->ui();
     }
 
     /**
@@ -60,22 +77,39 @@ public function performCommand($cmd)
      */
     public function configure()
     {
-        $this->initForm();
-        $this->fillForm();
-        $this->tpl->setContent($this->config_form->getHTML());
+        $this->tpl->setContent(
+            $this->ui->renderer()->render(
+                $this->initForm()
+            )
+        );
     }
 
     /**
      * Save configuration
      */
     public function save()
     {
-        ilMDViewerConfig::set(
-            ilMDViewerConfig::KEY_IDS_OF_AUTHORIZED_ROLES,
-            $_POST[ilMDViewerConfig::KEY_IDS_OF_AUTHORIZED_ROLES]
+        $form = $this->initForm();
+        $form = $form->withRequest($this->http->request());
+        $data = $form->getData();
+
+        if (!empty($data)) {
+            foreach ($data as $key => $value) {
+                ilMDViewerConfig::set(
+                    $key,
+                    $value
+                );
+            }
+
+            ilUtil::sendSuccess($this->lng->txt('saved_successfully'), true);
+            $this->ctrl->redirect($this, self::CMD_CONFIGURE);
+        }
+
+        $this->tpl->setContent(
+            $this->ui->renderer()->render(
+                $form
+            )
         );
-        ilUtil::sendSuccess($this->lng->txt('saved_successfully'), true);
-        $this->ctrl->redirect($this, self::CMD_CONFIGURE);
     }
 
     /**
@@ -88,40 +122,53 @@ public function cancel()
 
     /**
      * Initialize configuration-form
+     * @return \ILIAS\UI\Component\Input\Container\Form\Standard
      */
     protected function initForm()
     {
-        // form
-        $this->config_form = new ilPropertyFormGUI();
-        $this->config_form->setFormAction($this->ctrl->getFormAction($this));
-        $this->config_form->setTitle($this->getPluginObject()->txt('config_configuration'));
-
-        // multi select input for roles that shall be allowed to use the plugin
-        $authorized_roles = new ilMultiSelectInputGUI(
-            $this->getPluginObject()->txt("config_authorized_roles"),
-            ilMDViewerConfig::KEY_IDS_OF_AUTHORIZED_ROLES
+        return $this->ui->factory()->input()->container()->form()->standard(
+            $this->ctrl->getFormActionByClass(self::class, self::CMD_SAVE),
+            [
+                // multi select input for roles that shall be allowed to use the plugin.
+                ilMDViewerConfig::KEY_IDS_OF_AUTHORIZED_ROLES => $this->ui->factory()->input()->field()->multiSelect(
+                    $this->plugin->txt('config_authorized_roles'),
+                    $this->getConfigurableRoles()
+                )->withByline(
+                    $this->plugin->txt('config_info_authorized_roles')
+                )->withValue(
+                    ilMDViewerConfig::get(ilMDViewerConfig::KEY_IDS_OF_AUTHORIZED_ROLES) ?? ''
+                ),
+
+                // checkbox input for activating the blocks filter.
+                ilMDViewerConfig::KEY_MD_BLOCKS_FILTER_ACTIVE => $this->ui->factory()->input()->field()->checkbox(
+                    $this->plugin->txt('config_blocks_filter')
+                )->withByline(
+                    $this->plugin->txt('config_info_blocks_filter')
+                )->withValue(
+                    ilMDViewerConfig::get(ilMDViewerConfig::KEY_MD_BLOCKS_FILTER_ACTIVE) ?? false
+                ),
+            ]
         );
-        $authorized_roles->setOptions(self::getRoles(ilRbacReview::FILTER_ALL_GLOBAL));
-        $authorized_roles->setInfo($this->getPluginObject()->txt("config_info_authorized_roles"));
-        $authorized_roles->setRequired(true);
-        $this->config_form->addItem($authorized_roles);
-
-        // save and cancel buttons
-        $this->config_form->addCommandButton(self::CMD_SAVE, $this->lng->txt('save'));
-        $this->config_form->addCommandButton(self::CMD_CANCEL, $this->lng->txt('cancel'));
     }
 
-    public function fillForm()
+    /**
+     * @return array<int, string>
+     */
+    protected function getConfigurableRoles()
     {
-        $array = array(
-            ilMDViewerConfig::KEY_IDS_OF_AUTHORIZED_ROLES => ilMDViewerConfig::get(
-                ilMDViewerConfig::KEY_IDS_OF_AUTHORIZED_ROLES
-            ),
-        );
-        $this->config_form->setValuesByArray($array);
+        $roles = [];
+        foreach ($this->rbac->review()->getRolesByFilter(ilRbacReview::FILTER_ALL) as $role_data) {
+            $role_name = ilObjRole::_getTranslation($role_data['title']);
+            $role_id = (int) $role_data['obj_id'];
+
+            $roles[$role_id] = $role_name;
+        }
+
+        return $roles;
     }
 
     /**
+     * @deprecated
      * @param int  $filter
      * @param bool $with_text
      * @return array

classes/class.ilMDViewerPlugin.php

@@ -25,15 +25,25 @@ public function getPluginName()
      */
     public function isValidParentType($a_parent_type)
     {
-        global $rbacreview, $ilUser;
+        /** @var $ilUser ilObjUser */
+        global $ilUser;
+
+        return $this->isUserAuthorized($ilUser->getId());
+    }
+
+    /**
+     * @param int $user_id
+     * @return bool
+     */
+    public function isUserAuthorized($user_id)
+    {
+        /** @var $rbacreview ilRbacReview */
+        global $rbacreview;
 
         $authorized_roles = ilMDViewerConfig::get(ilMDViewerConfig::KEY_IDS_OF_AUTHORIZED_ROLES);
         if (!empty($authorized_roles)) {
             foreach ($authorized_roles as $authorized_role) {
-                /**
-                 * @var $rbacreview ilRbacReview
-                 */
-                if ($rbacreview->isAssigned($ilUser->getId(), $authorized_role)) {
+                if ($rbacreview->isAssigned($user_id, $authorized_role)) {
                     return true;
                 }
             }