Add setting 'private_messages_about_user' see BT#12622

- Allow send messages between boss, teachers that have access to
main/mySpace/myStudents.php?student=x

- Messages are related of a user.

Author: jmontoyaa

main/inc/lib/api.lib.php

@@ -537,6 +537,8 @@
 define('MESSAGE_STATUS_WALL', '8');
 define('MESSAGE_STATUS_WALL_DELETE', '9');
 define('MESSAGE_STATUS_WALL_POST', '10');
+define('MESSAGE_STATUS_CONVERSATION', '11');
+
 // Images
 define('IMAGE_WALL_SMALL_SIZE', 200);
 define('IMAGE_WALL_MEDIUM_SIZE', 500);

main/inc/lib/display.lib.php

@@ -2460,6 +2460,7 @@ public static function returnFontAwesomeIcon(
      * @param bool|true $open
      * @param bool|false $fullClickable
      * @return null|string
+     * @todo rework function to easy use
      */
     public static function panelCollapse(
         $title,

main/inc/lib/message.lib.php

@@ -176,6 +176,67 @@ public static function get_message_data($from, $number_of_items, $column, $direc
         return $message_list;
     }
 
+    /**
+     * @param array $aboutUserInfo
+     * @param array $fromUserInfo
+     * @param string $subject
+     * @param string $content
+     * @return bool
+     */
+    public static function sendMessageAboutUser(
+        $aboutUserInfo,
+        $fromUserInfo,
+        $subject,
+        $content
+    ) {
+        if (empty($aboutUserInfo) || empty($fromUserInfo)) {
+            return false;
+        }
+
+        if (empty($fromUserInfo['id']) || empty($aboutUserInfo['id'])) {
+            return false;
+        }
+
+        $table = Database::get_main_table(TABLE_MESSAGE);
+        $now = api_get_utc_datetime();
+        $params = [
+            'user_sender_id' => $fromUserInfo['id'],
+            'user_receiver_id' => $aboutUserInfo['id'],
+            'msg_status' => MESSAGE_STATUS_CONVERSATION,
+            'send_date' => $now,
+            'title' => $subject,
+            'content' => $content,
+            'group_id' => 0,
+            'parent_id' => 0,
+            'update_date' => $now
+        ];
+        $id = Database::insert($table, $params);
+        if ($id) {
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * @param array $aboutUserInfo
+     * @return array
+     */
+    public static function getMessagesAboutUser($aboutUserInfo)
+    {
+        if (!empty($aboutUserInfo)) {
+            $criteria = [
+              'userReceiverId' => $aboutUserInfo['id'],
+              'msgStatus' => MESSAGE_STATUS_CONVERSATION
+            ];
+            $repo = Database::getManager()->getRepository('ChamiloCoreBundle:Message');
+            $messages = $repo->findBy($criteria, ['sendDate' => 'DESC']);
+
+            return $messages;
+        }
+
+        return [];
+    }
 
     /**
      * Sends a message to a user/group
@@ -247,7 +308,7 @@ public static function send_message(
         if (empty($subject) && empty($group_id)) {
             Display::addFlash(Display::return_message(get_lang('YouShouldWriteASubject'), 'warning'));
             return false;
-        } else if ($total_filesize > intval(api_get_setting('message_max_upload_filesize'))) {
+        } elseif ($total_filesize > intval(api_get_setting('message_max_upload_filesize'))) {
             $warning = sprintf(
                 get_lang("FilesSizeExceedsX"),
                 format_file_size(api_get_setting('message_max_upload_filesize'))

main/install/configuration.dist.php

@@ -513,3 +513,7 @@
 // ------
 // Hide search form in session list
 //$_configuration['hide_search_form_in_session_list'] = false;
+// Allow conversation of student boss and teachers about user privately
+//$_configuration['private_messages_about_user'] = false;
+
+

main/mySpace/myStudents.php

@@ -3,6 +3,7 @@
 
 use Chamilo\CourseBundle\Entity\CLp;
 use Chamilo\CourseBundle\Entity\CLpCategory;
+use Chamilo\CoreBundle\Entity\Message;
 
 /**
  * Implements the tracking of students in the Reporting pages
@@ -17,10 +18,18 @@
 $origin = isset($_GET['origin']) ? Security::remove_XSS($_GET['origin']) : '';
 $course_code = isset($_GET['course']) ? Security::remove_XSS($_GET['course']) : '';
 $courseInfo = api_get_course_info($course_code);
-$student_id = intval($_GET['student']);
+$student_id = isset($_GET['student']) ? (int) $_GET['student'] : 0;
 
-$allowedToTrackUser = true;
+$currentUrl = api_get_self().'?student='.$student_id.'&course='.$course_code.'&id_session='.$sessionId.'&origin='.$origin;
+
+if (empty($student_id)) {
+    api_not_allowed(true);
+}
 
+// user info
+$user_info = api_get_user_info($student_id);
+
+$allowedToTrackUser = true;
 if (!api_is_session_admin() &&
     !api_is_drh() &&
     !api_is_student_boss() &&
@@ -184,11 +193,23 @@ function show_image(image,width,height) {
 $tbl_course_user = Database::get_main_table(TABLE_MAIN_COURSE_USER);
 $tbl_stats_exercices = Database::get_main_table(TABLE_STATISTIC_TRACK_E_EXERCISES);
 $user_id = isset($_GET['user_id']) && !empty($_GET['user_id']) ? (int) $_GET['user_id'] : api_get_user_id();
-
-// Action behaviour
 $action = isset($_GET['action']) ? $_GET['action'] : '';
 
 switch ($action) {
+    case 'send_message':
+        $subject = isset($_POST['subject']) ? $_POST['subject'] : '';
+        $message = isset($_POST['message']) ? $_POST['message'] : '';
+
+        MessageManager::sendMessageAboutUser(
+            $user_info,
+            api_get_user_info(),
+            $subject,
+            $message
+        );
+        Display::addFlash(Display::return_message(get_lang('MessageSent')));
+        header('Location: '.$currentUrl);
+        exit;
+        break;
     case 'send_legal':
         $subject = get_lang('SendLegalSubject');
         $content = sprintf(
@@ -225,18 +246,15 @@ function show_image(image,width,height) {
 
             // @todo delete the stats.track_e_exercises records.
             // First implement this http://support.chamilo.org/issues/1334
-            $message = Display::return_message(
+            Display::addFlash(Display::return_message(
                 get_lang('LPWasReset'),
                 'success'
-            );
+            ));
         }
         break;
     default:
         break;
 }
-
-// user info
-$user_info = api_get_user_info($student_id);
 $courses_in_session = array();
 
 //See #4676
@@ -252,11 +270,15 @@ function show_image(image,width,height) {
 // RRHH or session admin
 if (api_is_session_admin() || api_is_drh()) {
     $courses = CourseManager::get_courses_followed_by_drh(api_get_user_id());
-    $session_by_session_admin = SessionManager::get_sessions_followed_by_drh(api_get_user_id());
+    $session_by_session_admin = SessionManager::get_sessions_followed_by_drh(
+        api_get_user_id()
+    );
 
     if (!empty($session_by_session_admin)) {
         foreach ($session_by_session_admin as $session_coached_by_user) {
-            $courses_followed_by_coach = Tracking :: get_courses_list_from_session($session_coached_by_user['id']);
+            $courses_followed_by_coach = Tracking::get_courses_list_from_session(
+                $session_coached_by_user['id']
+            );
             $courses_in_session_by_coach[$session_coached_by_user['id']] = $courses_followed_by_coach;
         }
     }
@@ -278,7 +300,7 @@ function show_image(image,width,height) {
             user_id = ".intval($user_info['user_id']);
 $rs = Database::query($sql);
 
-while ($row = Database :: fetch_array($rs)) {
+while ($row = Database::fetch_array($rs)) {
     if ($drh_can_access_all_courses) {
         $courses_in_session[0][] = $row['c_id'];
     } else {
@@ -294,7 +316,7 @@ function show_image(image,width,height) {
         WHERE user_id=' . intval($user_info['user_id']);
 $rs = Database::query($sql);
 $tmp_sessions = array();
-while ($row = Database :: fetch_array($rs, 'ASSOC')) {
+while ($row = Database::fetch_array($rs, 'ASSOC')) {
     $tmp_sessions[] = $row['session_id'];
     if ($drh_can_access_all_courses) {
         if (in_array($row['session_id'], $tmp_sessions)) {
@@ -339,17 +361,8 @@ function show_image(image,width,height) {
 }
 
 Display::display_header($nameTools);
-
-if (isset($message)) {
-    echo $message;
-}
-
 $token = Security::get_token();
 
-if (empty($student_id)) {
-    api_not_allowed();
-}
-
 // Actions bar
 echo '<div class="actions">';
 echo '<a href="javascript: window.history.go(-1);">'.
@@ -980,7 +993,7 @@ function show_image(image,width,height) {
         $lps = $query->getResult();
         */
         if (true) {
-            $categoriesTempList = learnpath::getCategories(api_get_course_int_id());
+            $categoriesTempList = learnpath::getCategories($courseInfo['real_id']);
             $categoryTest = new CLpCategory();
             $categoryTest->setId(0);
             $categoryTest->setName(get_lang('WithOutCategory'));
@@ -1002,7 +1015,7 @@ function show_image(image,width,height) {
 
                 $list = new LearnpathList(
                     api_get_user_id(),
-                    null,
+                    $courseInfo['code'],
                     null,
                     null,
                     false,
@@ -1567,6 +1580,60 @@ function show_image(image,width,height) {
     $sessionId
 );
 
+$allowMessages = api_get_configuration_value('private_messages_about_user');
+if ($allowMessages === true) {
+    // Messages
+    echo Display::page_subheader2(get_lang('Messages'));
+    $messages = MessageManager::getMessagesAboutUser($user_info);
+
+    if (!empty($messages)) {
+        /** @var Message $message */
+        foreach ($messages as $message) {
+            $tag = 'message_'.$message->getId();
+            $tagAccordion = 'accordion_'.$message->getId();
+            $tagCollapse = 'collapse_'.$message->getId();
+            $date = Display::dateToStringAgoAndLongDate(
+                $message->getSendDate()
+            );
+            $senderId = $message->getUserSenderId();
+            $senderInfo = api_get_user_info($senderId);
+            echo Display::panelCollapse(
+                $message->getTitle(),
+                $message->getContent().'<br />'.$date.'<br />'.get_lang(
+                    'Author'
+                ).': '.$senderInfo['complete_name_with_message_link'],
+                $tag,
+                null,
+                $tagAccordion,
+                $tagCollapse,
+                false
+            );
+        }
+    }
+
+    echo Display::url(
+        get_lang('NewMessage'),
+        'javascript: void(0);',
+        [
+            'onClick' => "$('#compose_message').show();",
+            'class' => 'btn btn-default'
+        ]
+    );
+
+    $form = new FormValidator(
+        'messages',
+        'post',
+        api_get_self().'?action=send_message&student='.$student_id
+    );
+    $form->addHtml('<div id="compose_message" style="display:none;">');
+    $form->addText('subject', get_lang('Subject'));
+    $form->addHtmlEditor('message', get_lang('Message'));
+    $form->addButtonSend(get_lang('Send'));
+    $form->addHidden('sec_token', $token);
+    $form->addHtml('</div>');
+    $form->display();
+}
+
 if ($export) {
     ob_end_clean();
     switch ($export) {