Add possibility to disable or restrict users mentions in RichText

install/empty_data.php

@@ -35,6 +35,7 @@
 
 use Glpi\Form\Form;
 use Glpi\Inventory\Conf;
+use Glpi\RichText\UserMention;
 use Glpi\Socket;
 
 // Use anonymous class so we can have constants that define special values without polluting the global table
@@ -8899,6 +8900,7 @@ public function getEmptyData(): array
                 'is_default' => '1',
                 'helpdesk_hardware' => '1',
                 'helpdesk_item_type' => '["Computer","Monitor","NetworkEquipment","Peripheral","Phone","Printer","Software", "DCRoom", "Rack", "Enclosure", "Database"]',
+                'use_mentions' => UserMention::USER_MENTION_FULL,
                 'ticket_status' => '{"1":{"2":0,"3":0,"4":0,"5":0,"6":0},"2":{"1":0,"3":0,"4":0,"5":0,"6":0},"3":{"1":0,"2":0,"4":0,"5":0,"6":0},"4":{"1":0,"2":0,"3":0,"5":0,"6":0},"5":{"1":0,"2":0,"3":0,"4":0},"6":{"1":0,"2":0,"3":0,"4":0,"5":0}}',
                 'comment' => '',
                 'problem_status' => '[]',
@@ -8913,6 +8915,7 @@ public function getEmptyData(): array
                 'is_default' => '0',
                 'helpdesk_hardware' => '1',
                 'helpdesk_item_type' => '["Computer","Monitor","NetworkEquipment","Peripheral","Phone","Printer","Software", "DCRoom", "Rack", "Enclosure", "Database"]',
+                'use_mentions' => UserMention::USER_MENTION_FULL,
                 'ticket_status' => '[]',
                 'comment' => '',
                 'problem_status' => '[]',
@@ -8927,6 +8930,7 @@ public function getEmptyData(): array
                 'is_default' => '0',
                 'helpdesk_hardware' => '3',
                 'helpdesk_item_type' => '["Computer","Monitor","NetworkEquipment","Peripheral","Phone","Printer","Software", "DCRoom", "Rack", "Enclosure", "Database"]',
+                'use_mentions' => UserMention::USER_MENTION_FULL,
                 'ticket_status' => '[]',
                 'comment' => '',
                 'problem_status' => '[]',
@@ -8941,6 +8945,7 @@ public function getEmptyData(): array
                 'is_default' => '0',
                 'helpdesk_hardware' => '3',
                 'helpdesk_item_type' => '["Computer","Monitor","NetworkEquipment","Peripheral","Phone","Printer","Software", "DCRoom", "Rack", "Enclosure", "Database"]',
+                'use_mentions' => UserMention::USER_MENTION_FULL,
                 'ticket_status' => '[]',
                 'comment' => '',
                 'problem_status' => '[]',
@@ -8955,6 +8960,7 @@ public function getEmptyData(): array
                 'is_default' => '0',
                 'helpdesk_hardware' => '3',
                 'helpdesk_item_type' => '["Computer","Monitor","NetworkEquipment","Peripheral","Phone","Printer","Software", "DCRoom", "Rack", "Enclosure", "Database"]',
+                'use_mentions' => UserMention::USER_MENTION_FULL,
                 'ticket_status' => '[]',
                 'comment' => '',
                 'problem_status' => '[]',
@@ -8969,6 +8975,7 @@ public function getEmptyData(): array
                 'is_default' => '0',
                 'helpdesk_hardware' => '3',
                 'helpdesk_item_type' => '["Computer","Monitor","NetworkEquipment","Peripheral","Phone","Printer","Software", "DCRoom", "Rack", "Enclosure", "Database"]',
+                'use_mentions' => UserMention::USER_MENTION_FULL,
                 'ticket_status' => '[]',
                 'comment' => '',
                 'problem_status' => '[]',
@@ -8983,6 +8990,7 @@ public function getEmptyData(): array
                 'is_default' => '0',
                 'helpdesk_hardware' => '3',
                 'helpdesk_item_type' => '["Computer","Monitor","NetworkEquipment","Peripheral","Phone","Printer","Software", "DCRoom", "Rack", "Enclosure", "Database"]',
+                'use_mentions' => UserMention::USER_MENTION_FULL,
                 'ticket_status' => '[]',
                 'comment' => '',
                 'problem_status' => '[]',
@@ -8997,6 +9005,7 @@ public function getEmptyData(): array
                 'is_default' => '0',
                 'helpdesk_hardware' => '0',
                 'helpdesk_item_type' => '[]',
+                'use_mentions' => UserMention::USER_MENTION_FULL,
                 'ticket_status' => '{"1":{"2":0,"3":0,"4":0,"5":0,"6":0},"2":{"1":0,"3":0,"4":0,"5":0,"6":0},"3":{"1":0,"2":0,"4":0,"5":0,"6":0},"4":{"1":0,"2":0,"3":0,"5":0,"6":0},"5":{"1":0,"2":0,"3":0,"4":0,"6":0},"6":{"1":0,"2":0,"3":0,"4":0,"5":0}}',
                 'comment' => 'This profile defines read-only access. It is used when objects are locked. It can also be used to give to users rights to unlock objects.',
                 'problem_status' => '{"1":{"7":0,"2":0,"3":0,"4":0,"5":0,"8":0,"6":0},"7":{"1":0,"2":0,"3":0,"4":0,"5":0,"8":0,"6":0},"2":{"1":0,"7":0,"3":0,"4":0,"5":0,"8":0,"6":0},"3":{"1":0,"7":0,"2":0,"4":0,"5":0,"8":0,"6":0},"4":{"1":0,"7":0,"2":0,"3":0,"5":0,"8":0,"6":0},"5":{"1":0,"7":0,"2":0,"3":0,"4":0,"8":0,"6":0},"8":{"1":0,"7":0,"2":0,"3":0,"4":0,"5":0,"6":0},"6":{"1":0,"7":0,"2":0,"3":0,"4":0,"5":0,"8":0}}',

install/migrations/update_10.0.x_to_11.0.0/profiles.php

@@ -33,6 +33,8 @@
  * ---------------------------------------------------------------------
  */
 
+use Glpi\RichText\UserMention;
+
 /**
  * @var \Migration $migration
  */
@@ -47,3 +49,14 @@
     ]
 );
 $migration->addKey('glpi_profiles', 'last_rights_update');
+
+$migration->addField(
+    'glpi_profiles',
+    'use_mentions',
+    'int',
+    [
+        'null' => false,
+        'value' => UserMention::USER_MENTION_FULL,
+        'after' => 'helpdesk_item_type'
+    ]
+);

install/mysql/glpi-empty.sql

@@ -5824,6 +5824,7 @@ CREATE TABLE `glpi_profiles` (
   `is_default` tinyint NOT NULL DEFAULT '0',
   `helpdesk_hardware` int NOT NULL DEFAULT '0',
   `helpdesk_item_type` text,
+  `use_mentions` int NOT NULL DEFAULT '1',
   `ticket_status` text COMMENT 'json encoded array of from/dest allowed status change',
   `date_mod` timestamp NULL DEFAULT NULL,
   `comment` text,

js/RichText/UserMention.js

@@ -47,11 +47,13 @@ window.GLPI.RichText.UserMention = class {
     * @param {Editor} editor
     * @param {number} activeEntity
     * @param {string} idorToken
+    * @param {Array} mentions_options
     */
-    constructor(editor, activeEntity, idorToken) {
+    constructor(editor, activeEntity, idorToken, mentions_options) {
         this.editor = editor;
         this.activeEntity = activeEntity;
         this.idorToken = idorToken;
+        this.mentionsOptions = mentions_options;
     }
 
     /**
@@ -99,7 +101,14 @@ window.GLPI.RichText.UserMention = class {
                     }
                 ).done(
                     (data) => {
-                        const items = data.results.map(
+                        let results = data.results;
+
+                        if (!this.mentionsOptions.full) {
+                            const allowedIds = this.mentionsOptions.users;
+                            results = results.filter(user => allowedIds.includes(user.id));
+                        }
+
+                        const items = results.map(
                             (user) => {
                                 return {
                                     type: 'autocompleteitem',

src/CommonITILObject.php

@@ -43,6 +43,7 @@
 use Glpi\Form\Destination\AnswersSet_FormDestinationItem;
 use Glpi\Plugin\Hooks;
 use Glpi\RichText\RichText;
+use Glpi\RichText\UserMention;
 use Glpi\Team\Team;
 
 /**
@@ -7358,6 +7359,8 @@ public function getTimelineItemtypes(): array
 
         $itemtypes = [];
 
+        $use_mentions = UserMention::getRestrictedUsers($this);
+
         $itemtypes['answer'] = [
             'type'          => 'ITILFollowup',
             'class'         => 'ITILFollowup',
@@ -7366,7 +7369,8 @@ public function getTimelineItemtypes(): array
             'short_label'   => _x('button', 'Answer'),
             'template'      => 'components/itilobject/timeline/form_followup.html.twig',
             'item'          => $fup,
-            'hide_in_menu'  => !$canadd_fup
+            'hide_in_menu'  => !$canadd_fup,
+            'use_mentions'    => $use_mentions,
         ];
         $itemtypes['task'] = [
             'type'          => 'ITILTask',
@@ -7376,7 +7380,8 @@ public function getTimelineItemtypes(): array
             'short_label'   => _x('button', 'Task'),
             'template'      => 'components/itilobject/timeline/form_task.html.twig',
             'item'          => $task,
-            'hide_in_menu'  => !$canadd_task
+            'hide_in_menu'  => !$canadd_task,
+            'use_mentions'    => $use_mentions,
         ];
         $itemtypes['solution'] = [
             'type'          => 'ITILSolution',
@@ -7386,7 +7391,8 @@ public function getTimelineItemtypes(): array
             'short_label'   => _x('button', 'Solution'),
             'template'      => 'components/itilobject/timeline/form_solution.html.twig',
             'item'          => new ITILSolution(),
-            'hide_in_menu'  => !$canadd_solution
+            'hide_in_menu'  => !$canadd_solution,
+            'use_mentions'    => $use_mentions,
         ];
         $itemtypes['document'] = [
             'type'          => 'Document_Item',
@@ -7396,7 +7402,8 @@ public function getTimelineItemtypes(): array
             'short_label'   => _x('button', 'Document'),
             'template'      => 'components/itilobject/timeline/form_document_item.html.twig',
             'item'          => new Document_Item(),
-            'hide_in_menu'  => !$canadd_document
+            'hide_in_menu'  => !$canadd_document,
+            'use_mentions'    => $use_mentions,
         ];
         if ($validation !== null) {
             $itemtypes['validation'] = [
@@ -7407,7 +7414,8 @@ public function getTimelineItemtypes(): array
                 'short_label'   => _x('button', 'Validation'),
                 'template'      => 'components/itilobject/timeline/form_validation.html.twig',
                 'item'          => $validation,
-                'hide_in_menu'  => !$canadd_validation
+                'hide_in_menu'  => !$canadd_validation,
+                'use_mentions'    => $use_mentions,
             ];
         }
 

src/Glpi/RichText/UserMention.php

@@ -44,10 +44,15 @@
 use ITILFollowup;
 use ITILSolution;
 use NotificationEvent;
+use Profile;
 use User;
 
 final class UserMention
 {
+    const USER_MENTION_DISABLED = 0;
+    const USER_MENTION_FULL = 1;
+    const USER_MENTION_RESTRICTED = 2;
+
     /**
      * Handle user mentions.
      * Add newly mention users to observers and send them a notification.
@@ -261,4 +266,46 @@ public static function refreshUserMentionsHtmlToDisplay(string $content): string
 
         return $content;
     }
+
+    public static function isEnabled(): bool
+    {
+        $pro = Profile::getById($_SESSION['glpiactiveprofile']['id']);
+        return $pro->fields['use_mentions'] !== self::USER_MENTION_DISABLED;
+    }
+
+    public static function isMentionsRestricted(): bool
+    {
+        $pro = Profile::getById($_SESSION['glpiactiveprofile']['id']);
+        return $pro->fields['use_mentions'] === self::USER_MENTION_RESTRICTED;
+    }
+
+    public static function getRestrictedUsers(CommonITILObject $item): array
+    {
+        $data = [
+            'enabled' => self::isEnabled(),
+        ];
+
+        if (!self::isMentionsRestricted()) {
+            $data['full'] = true;
+            return $data;
+        } else {
+            $data['full'] = false;
+        }
+
+        $items_id = $item->getID();
+
+        //get actors from item
+        $userlink = new $item->userlinkclass();
+        $actors = $userlink->getActors($items_id);
+
+        $data['users'] = [];
+
+        foreach ($actors as $actor) {
+            foreach ($actor as $a) {
+                $data['users'][] = $a['users_id'];
+            }
+        }
+
+        return $data;
+    }
 }

src/Profile.php

@@ -41,6 +41,7 @@
 use Glpi\Form\Form;
 use Glpi\Helpdesk\DefaultDataManager;
 use Glpi\Helpdesk\Tile\TilesManager;
+use Glpi\RichText\UserMention;
 use Glpi\Session\SessionInfo;
 use Glpi\Toolbox\ArrayNormalizer;
 
@@ -68,6 +69,7 @@ class Profile extends CommonDBTM
         'reservation',
         'rssfeed_public',
         'show_group_hardware',
+        'use_mentions',
         'task',
         'ticket',
         'ticket_cost',
@@ -1538,6 +1540,10 @@ public function showFormTools($openform = true, $closeform = true)
      **/
     public function showFormTracking($openform = true, $closeform = true)
     {
+        /** @var array $CFG_GLPI */
+
+        global $CFG_GLPI;
+
         if (!self::canView()) {
             return false;
         }
@@ -1597,6 +1603,60 @@ public function showFormTracking($openform = true, $closeform = true)
         $matrix_options['title'] = _n('Followup', 'Followups', Session::getPluralNumber()) . " / " . _n('Task', 'Tasks', Session::getPluralNumber());
         $this->displayRightsChoiceMatrix(self::getRightsForForm('central', 'tracking', 'followups_tasks'), $matrix_options);
 
+        echo "<div class='mt-n2 mx-n2 mb-4'>";
+        echo "<table class='table table-hover card-table'>";
+        echo "<thead>";
+        echo "<tr><th colspan='2'><h4>" . __s('Users mentions') . "<h4></th></tr>";
+
+        echo "</thead>";
+
+        echo "<tbody>";
+
+        $description = __s('Enables or disables the ability to mention users within the application.') . "<br><br>";
+        $description .= "<b>" . __s('Disabled') . "</b> : " . __('User mentions are disabled for this profile.') . "<br><br>";
+        $description .= "<b>" . __s('Full') . "</b> : " . __('Displays all users. Mentioned users will be added as observers if they are not already actors.') . "<br><br>";
+        $description .= "<b>" . __s('Restricted') . "</b> : " . __('Limits the display to actors directly involved in the ticket.') . "<br><br><br>";
+
+        $disabled = false;
+
+        if ($CFG_GLPI['use_notifications'] == '0') {
+            $disabled = true;
+        }
+
+        echo "<tr>";
+        echo "<td>" . __s('Mentions configuration');
+        echo "<span class='ms-2 form-help'
+              data-bs-toggle='popover'
+              data-bs-placement='top'
+              data-bs-html='true'
+              data-bs-content='" . htmlspecialchars($description) . "'>
+            ?
+        </span>";
+        echo "</td><td>";
+
+        echo Dropdown::showFromArray(
+            'use_mentions',
+            self::getMentionsLists($disabled),
+            [
+                'value' => $this->fields['use_mentions'],
+                'display' => false,
+                'disabled' => $disabled
+            ]
+        );
+
+        if ($disabled) {
+            $warning = __('Notifications must be enabled to activate mentions.');
+            echo "<span class='form-help ms-2' data-bs-toggle='popover' data-bs-placement='top' data-bs-html='true' data-bs-content='" . $warning . "'>";
+            echo "<i class='fas fa-exclamation-triangle text-danger'></i>";
+            echo "</span>";
+        }
+
+        echo "</td></tr>";
+
+        echo "</tbody>";
+        echo "</table>";
+        echo "</div>";
+
         $matrix_options['title'] = _n('Validation', 'Validations', Session::getPluralNumber());
         $this->displayRightsChoiceMatrix(self::getRightsForForm('central', 'tracking', 'validations'), $matrix_options);
 
@@ -4015,6 +4075,33 @@ public static function dropdownHelpdeskItemtypes($options)
         return Dropdown::showFromArray($p['name'], $values, $p);
     }
 
+    /**
+     * @return array<int, string>
+     **/
+    public static function getMentionsLists(bool $disabled): array
+    {
+        if ($disabled) {
+            return [
+                UserMention::USER_MENTION_DISABLED => __('Disabled'),
+            ];
+        }
+
+        return [
+            UserMention::USER_MENTION_DISABLED     => __('Disabled'),
+            UserMention::USER_MENTION_FULL        => __('Full'),
+            UserMention::USER_MENTION_RESTRICTED  => __('Restricted'),
+        ];
+    }
+
+    /**
+     * @param $value
+     * @return string
+     */
+    public static function getMentionsListName($value): string
+    {
+        return self::getMentionsLists(false)[$value] ?? NOT_AVAILABLE;
+    }
+
     /**
      * Check if user has given right.
      *