[Summary view]

Differences Between: [Versions 310 and 311] [Versions 311 and 400] [Versions 311 and 401] [Versions 311 and 402] [Versions 311 and 403] [Versions 39 and 311]

   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  
  17  /**
  18   * Contains helper class for the message area.
  19   *
  20   * @package    core_message
  21   * @copyright  2016 Mark Nelson <markn@moodle.com>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core_message;
  26  use DOMDocument;
  27  
  28  defined('MOODLE_INTERNAL') || die();
  29  
  30  require_once($CFG->dirroot . '/message/lib.php');
  31  
  32  /**
  33   * Helper class for the message area.
  34   *
  35   * @copyright  2016 Mark Nelson <markn@moodle.com>
  36   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  37   */
  38  class helper {
  39  
  40      /**
  41       * @deprecated since 3.6
  42       */
  43      public static function get_messages() {
  44          throw new \coding_exception('\core_message\helper::get_messages has been removed.');
  45      }
  46  
  47      /**
  48       * Helper function to retrieve conversation messages.
  49       *
  50       * @param  int $userid The current user.
  51       * @param  int $convid The conversation identifier.
  52       * @param  int $timedeleted The time the message was deleted
  53       * @param  int $limitfrom Return a subset of records, starting at this point (optional).
  54       * @param  int $limitnum Return a subset comprising this many records in total (optional, required if $limitfrom is set).
  55       * @param  string $sort The column name to order by including optionally direction.
  56       * @param  int $timefrom The time from the message being sent.
  57       * @param  int $timeto The time up until the message being sent.
  58       * @return array of messages
  59       */
  60      public static function get_conversation_messages(int $userid, int $convid, int $timedeleted = 0, int $limitfrom = 0,
  61                                                       int $limitnum = 0, string $sort = 'timecreated ASC', int $timefrom = 0,
  62                                                       int $timeto = 0) : array {
  63          global $DB;
  64  
  65          $sql = "SELECT m.id, m.useridfrom, m.subject, m.fullmessage, m.fullmessagehtml,
  66                         m.fullmessageformat, m.fullmessagetrust, m.smallmessage, m.timecreated,
  67                         mc.contextid, muaread.timecreated AS timeread
  68                    FROM {message_conversations} mc
  69              INNER JOIN {messages} m
  70                      ON m.conversationid = mc.id
  71               LEFT JOIN {message_user_actions} muaread
  72                      ON (muaread.messageid = m.id
  73                     AND muaread.userid = :userid1
  74                     AND muaread.action = :readaction)";
  75          $params = ['userid1' => $userid, 'readaction' => api::MESSAGE_ACTION_READ, 'convid' => $convid];
  76  
  77          if (empty($timedeleted)) {
  78              $sql .= " LEFT JOIN {message_user_actions} mua
  79                               ON (mua.messageid = m.id
  80                              AND mua.userid = :userid2
  81                              AND mua.action = :deleteaction
  82                              AND mua.timecreated is NOT NULL)";
  83          } else {
  84              $sql .= " INNER JOIN {message_user_actions} mua
  85                                ON (mua.messageid = m.id
  86                               AND mua.userid = :userid2
  87                               AND mua.action = :deleteaction
  88                               AND mua.timecreated = :timedeleted)";
  89              $params['timedeleted'] = $timedeleted;
  90          }
  91  
  92          $params['userid2'] = $userid;
  93          $params['deleteaction'] = api::MESSAGE_ACTION_DELETED;
  94  
  95          $sql .= " WHERE mc.id = :convid";
  96  
  97          if (!empty($timefrom)) {
  98              $sql .= " AND m.timecreated >= :timefrom";
  99              $params['timefrom'] = $timefrom;
 100          }
 101  
 102          if (!empty($timeto)) {
 103              $sql .= " AND m.timecreated <= :timeto";
 104              $params['timeto'] = $timeto;
 105          }
 106  
 107          if (empty($timedeleted)) {
 108              $sql .= " AND mua.id is NULL";
 109          }
 110  
 111          $sql .= " ORDER BY m.$sort";
 112  
 113          $messages = $DB->get_records_sql($sql, $params, $limitfrom, $limitnum);
 114  
 115          return $messages;
 116      }
 117  
 118      /**
 119       * Helper function to return a conversation messages with the involved members (only the ones
 120       * who have sent any of these messages).
 121       *
 122       * @param int $userid The current userid.
 123       * @param int $convid The conversation id.
 124       * @param array $messages The formated array messages.
 125       * @return array A conversation array with the messages and the involved members.
 126       */
 127      public static function format_conversation_messages(int $userid, int $convid, array $messages) : array {
 128          global $USER;
 129  
 130          // Create the conversation array.
 131          $conversation = array(
 132              'id' => $convid,
 133          );
 134  
 135          // Store the messages.
 136          $arrmessages = array();
 137  
 138          foreach ($messages as $message) {
 139              // Store the message information.
 140              $msg = new \stdClass();
 141              $msg->id = $message->id;
 142              $msg->useridfrom = $message->useridfrom;
 143              $msg->text = message_format_message_text($message);
 144              $msg->timecreated = $message->timecreated;
 145              $arrmessages[] = $msg;
 146          }
 147          // Add the messages to the conversation.
 148          $conversation['messages'] = $arrmessages;
 149  
 150          // Get the users who have sent any of the $messages.
 151          $memberids = array_unique(array_map(function($message) {
 152              return $message->useridfrom;
 153          }, $messages));
 154  
 155          if (!empty($memberids)) {
 156              // Get members information.
 157              $conversation['members'] = self::get_member_info($userid, $memberids);
 158          } else {
 159              $conversation['members'] = array();
 160          }
 161  
 162          return $conversation;
 163      }
 164  
 165      /**
 166       * @deprecated since 3.6
 167       */
 168      public static function create_messages() {
 169          throw new \coding_exception('\core_message\helper::create_messages has been removed.');
 170      }
 171  
 172      /**
 173       * Helper function for creating a contact object.
 174       *
 175       * @param \stdClass $contact
 176       * @param string $prefix
 177       * @return \stdClass
 178       */
 179      public static function create_contact($contact, $prefix = '') {
 180          global $PAGE;
 181  
 182          // Create the data we are going to pass to the renderable.
 183          $userfields = \user_picture::unalias($contact, array('lastaccess'), $prefix . 'id', $prefix);
 184          $data = new \stdClass();
 185          $data->userid = $userfields->id;
 186          $data->useridfrom = null;
 187          $data->fullname = fullname($userfields);
 188          // Get the user picture data.
 189          $userpicture = new \user_picture($userfields);
 190          $userpicture->size = 1; // Size f1.
 191          $data->profileimageurl = $userpicture->get_url($PAGE)->out(false);
 192          $userpicture->size = 0; // Size f2.
 193          $data->profileimageurlsmall = $userpicture->get_url($PAGE)->out(false);
 194          // Store the message if we have it.
 195          $data->ismessaging = false;
 196          $data->lastmessage = null;
 197          $data->lastmessagedate = null;
 198          $data->messageid = null;
 199          if (isset($contact->smallmessage)) {
 200              $data->ismessaging = true;
 201              // Strip the HTML tags from the message for displaying in the contact area.
 202              $data->lastmessage = clean_param($contact->smallmessage, PARAM_NOTAGS);
 203              $data->lastmessagedate = $contact->timecreated;
 204              $data->useridfrom = $contact->useridfrom;
 205              if (isset($contact->messageid)) {
 206                  $data->messageid = $contact->messageid;
 207              }
 208          }
 209          $data->isonline = null;
 210          $user = \core_user::get_user($data->userid);
 211          if (self::show_online_status($user)) {
 212              $data->isonline = self::is_online($userfields->lastaccess);
 213          }
 214          $data->isblocked = isset($contact->blocked) ? (bool) $contact->blocked : false;
 215          $data->isread = isset($contact->isread) ? (bool) $contact->isread : false;
 216          $data->unreadcount = isset($contact->unreadcount) ? $contact->unreadcount : null;
 217          $data->conversationid = $contact->conversationid ?? null;
 218  
 219          return $data;
 220      }
 221  
 222      /**
 223       * Helper function for checking if we should show the user's online status.
 224       *
 225       * @param \stdClass $user
 226       * @return boolean
 227       */
 228      public static function show_online_status($user) {
 229          global $CFG;
 230  
 231          require_once($CFG->dirroot . '/user/lib.php');
 232  
 233          if ($lastaccess = user_get_user_details($user, null, array('lastaccess'))) {
 234              if (isset($lastaccess['lastaccess'])) {
 235                  return true;
 236              }
 237          }
 238  
 239          return false;
 240      }
 241  
 242      /**
 243       * Helper function for checking the time meets the 'online' condition.
 244       *
 245       * @param int $lastaccess
 246       * @return boolean
 247       */
 248      public static function is_online($lastaccess) {
 249          global $CFG;
 250  
 251          // Variable to check if we consider this user online or not.
 252          $timetoshowusers = 300; // Seconds default.
 253          if (isset($CFG->block_online_users_timetosee)) {
 254              $timetoshowusers = $CFG->block_online_users_timetosee * 60;
 255          }
 256          $time = time() - $timetoshowusers;
 257  
 258          return $lastaccess >= $time;
 259      }
 260  
 261      /**
 262       * Get providers preferences.
 263       *
 264       * @param array $providers
 265       * @param int $userid
 266       * @return \stdClass
 267       */
 268      public static function get_providers_preferences($providers, $userid) {
 269          $preferences = new \stdClass();
 270  
 271          // Get providers preferences.
 272          foreach ($providers as $provider) {
 273              foreach (array('loggedin', 'loggedoff') as $state) {
 274                  $linepref = get_user_preferences('message_provider_' . $provider->component . '_' . $provider->name
 275                      . '_' . $state, '', $userid);
 276                  if ($linepref == '') {
 277                      continue;
 278                  }
 279                  $lineprefarray = explode(',', $linepref);
 280                  $preferences->{$provider->component.'_'.$provider->name.'_'.$state} = array();
 281                  foreach ($lineprefarray as $pref) {
 282                      $preferences->{$provider->component.'_'.$provider->name.'_'.$state}[$pref] = 1;
 283                  }
 284              }
 285          }
 286  
 287          return $preferences;
 288      }
 289  
 290      /**
 291       * Requires the JS libraries for the toggle contact button.
 292       *
 293       * @return void
 294       */
 295      public static function togglecontact_requirejs() {
 296          global $PAGE;
 297  
 298          static $done = false;
 299          if ($done) {
 300              return;
 301          }
 302  
 303          $PAGE->requires->js_call_amd('core_message/toggle_contact_button', 'enhance', array('#toggle-contact-button'));
 304          $done = true;
 305      }
 306  
 307      /**
 308       * Returns the attributes to place on a contact button.
 309       *
 310       * @param object $user User object.
 311       * @param bool $iscontact
 312       * @return array
 313       */
 314      public static function togglecontact_link_params($user, $iscontact = false) {
 315          global $USER;
 316          $params = array(
 317              'data-currentuserid' => $USER->id,
 318              'data-userid' => $user->id,
 319              'data-is-contact' => $iscontact,
 320              'id' => 'toggle-contact-button',
 321              'role' => 'button',
 322              'class' => 'ajax-contact-button',
 323          );
 324  
 325          return $params;
 326      }
 327  
 328      /**
 329       * Requires the JS libraries for the message user button.
 330       *
 331       * @return void
 332       */
 333      public static function messageuser_requirejs() {
 334          global $PAGE;
 335  
 336          static $done = false;
 337          if ($done) {
 338              return;
 339          }
 340  
 341          $PAGE->requires->js_call_amd('core_message/message_user_button', 'send', array('#message-user-button'));
 342          $done = true;
 343      }
 344  
 345      /**
 346       * Returns the attributes to place on the message user button.
 347       *
 348       * @param int $useridto
 349       * @return array
 350       */
 351      public static function messageuser_link_params(int $useridto) : array {
 352          global $USER;
 353  
 354          return [
 355              'id' => 'message-user-button',
 356              'role' => 'button',
 357              'data-conversationid' => api::get_conversation_between_users([$USER->id, $useridto]),
 358              'data-userid' => $useridto,
 359          ];
 360      }
 361  
 362      /**
 363       * Returns the conversation hash between users for easy look-ups in the DB.
 364       *
 365       * @param array $userids
 366       * @return string
 367       */
 368      public static function get_conversation_hash(array $userids) {
 369          sort($userids);
 370  
 371          return sha1(implode('-', $userids));
 372      }
 373  
 374      /**
 375       * Returns the cache key for the time created value of the last message of this conversation.
 376       *
 377       * @param int $convid The conversation identifier.
 378       * @return string The key.
 379       */
 380      public static function get_last_message_time_created_cache_key(int $convid) {
 381          return $convid;
 382      }
 383  
 384      /**
 385       * Checks if legacy messages exist for a given user.
 386       *
 387       * @param int $userid
 388       * @return bool
 389       */
 390      public static function legacy_messages_exist($userid) {
 391          global $DB;
 392  
 393          $sql = "SELECT id
 394                    FROM {message} m
 395                   WHERE useridfrom = ?
 396                      OR useridto = ?";
 397          $messageexists = $DB->record_exists_sql($sql, [$userid, $userid]);
 398  
 399          $sql = "SELECT id
 400                    FROM {message_read} m
 401                   WHERE useridfrom = ?
 402                      OR useridto = ?";
 403          $messagereadexists = $DB->record_exists_sql($sql, [$userid, $userid]);
 404  
 405          return $messageexists || $messagereadexists;
 406      }
 407  
 408      /**
 409       * Returns conversation member info for the supplied users, relative to the supplied referenceuserid.
 410       *
 411       * This is the basic structure used when returning members, and includes information about the relationship between each member
 412       * and the referenceuser, such as a whether the referenceuser has marked the member as a contact, or has blocked them.
 413       *
 414       * @param int $referenceuserid the id of the user which check contact and blocked status.
 415       * @param array $userids
 416       * @param bool $includecontactrequests Do we want to include contact requests with this data?
 417       * @param bool $includeprivacyinfo Do we want to include whether the user can message another, and if the user
 418       *             requires a contact.
 419       * @return array the array of objects containing member info, indexed by userid.
 420       * @throws \coding_exception
 421       * @throws \dml_exception
 422       */
 423      public static function get_member_info(int $referenceuserid, array $userids, bool $includecontactrequests = false,
 424                                             bool $includeprivacyinfo = false) : array {
 425          global $DB, $PAGE;
 426  
 427          // Prevent exception being thrown when array is empty.
 428          if (empty($userids)) {
 429              return [];
 430          }
 431  
 432          list($useridsql, $usersparams) = $DB->get_in_or_equal($userids);
 433          $userfieldsapi = \core_user\fields::for_userpic()->including('lastaccess');
 434          $userfields = $userfieldsapi->get_sql('u', false, '', '', false)->selects;
 435          $userssql = "SELECT $userfields, u.deleted, mc.id AS contactid, mub.id AS blockedid
 436                         FROM {user} u
 437                    LEFT JOIN {message_contacts} mc
 438                           ON ((mc.userid = ? AND mc.contactid = u.id) OR (mc.userid = u.id AND mc.contactid = ?))
 439                    LEFT JOIN {message_users_blocked} mub
 440                           ON (mub.userid = ? AND mub.blockeduserid = u.id)
 441                        WHERE u.id $useridsql";
 442          $usersparams = array_merge([$referenceuserid, $referenceuserid, $referenceuserid], $usersparams);
 443          $otherusers = $DB->get_records_sql($userssql, $usersparams);
 444  
 445          $members = [];
 446          foreach ($otherusers as $member) {
 447              // Set basic data.
 448              $data = new \stdClass();
 449              $data->id = $member->id;
 450              $data->fullname = fullname($member);
 451  
 452              // Create the URL for their profile.
 453              $profileurl = new \moodle_url('/user/profile.php', ['id' => $member->id]);
 454              $data->profileurl = $profileurl->out(false);
 455  
 456              // Set the user picture data.
 457              $userpicture = new \user_picture($member);
 458              $userpicture->size = 1; // Size f1.
 459              $data->profileimageurl = $userpicture->get_url($PAGE)->out(false);
 460              $userpicture->size = 0; // Size f2.
 461              $data->profileimageurlsmall = $userpicture->get_url($PAGE)->out(false);
 462  
 463              // Set online status indicators.
 464              $data->isonline = false;
 465              $data->showonlinestatus = false;
 466              if (!$member->deleted) {
 467                  $data->isonline = self::show_online_status($member) ? self::is_online($member->lastaccess) : null;
 468                  $data->showonlinestatus = is_null($data->isonline) ? false : true;
 469              }
 470  
 471              // Set contact and blocked status indicators.
 472              $data->iscontact = ($member->contactid) ? true : false;
 473  
 474              // We don't want that a user has been blocked if they can message the user anyways.
 475              $canmessageifblocked = api::can_send_message($referenceuserid, $member->id, true);
 476              $data->isblocked = ($member->blockedid && !$canmessageifblocked) ? true : false;
 477  
 478              $data->isdeleted = ($member->deleted) ? true : false;
 479  
 480              $data->requirescontact = null;
 481              $data->canmessage = null;
 482              $data->canmessageevenifblocked = null;
 483              if ($includeprivacyinfo) {
 484                  $privacysetting = api::get_user_privacy_messaging_preference($member->id);
 485                  $data->requirescontact = $privacysetting == api::MESSAGE_PRIVACY_ONLYCONTACTS;
 486  
 487                  // Here we check that if the sender wanted to block the recipient, the
 488                  // recipient would still be able to message them regardless.
 489                  $data->canmessageevenifblocked = !$data->isdeleted && $canmessageifblocked;
 490                  $data->canmessage = !$data->isdeleted && api::can_send_message($member->id, $referenceuserid);
 491              }
 492  
 493              // Populate the contact requests, even if we don't need them.
 494              $data->contactrequests = [];
 495  
 496              $members[$data->id] = $data;
 497          }
 498  
 499          // Check if we want to include contact requests as well.
 500          if (!empty($members) && $includecontactrequests) {
 501              list($useridsql, $usersparams) = $DB->get_in_or_equal($userids);
 502  
 503              $wheresql = "(userid $useridsql AND requesteduserid = ?) OR (userid = ? AND requesteduserid $useridsql)";
 504              $params = array_merge($usersparams, [$referenceuserid, $referenceuserid], $usersparams);
 505              if ($contactrequests = $DB->get_records_select('message_contact_requests', $wheresql, $params,
 506                      'timecreated ASC, id ASC')) {
 507                  foreach ($contactrequests as $contactrequest) {
 508                      if (isset($members[$contactrequest->userid])) {
 509                          $members[$contactrequest->userid]->contactrequests[] = $contactrequest;
 510                      }
 511                      if (isset($members[$contactrequest->requesteduserid])) {
 512                          $members[$contactrequest->requesteduserid]->contactrequests[] = $contactrequest;
 513                      }
 514                  }
 515              }
 516          }
 517  
 518          // Remove any userids not in $members. This can happen in the case of a user who has been deleted
 519          // from the Moodle database table (which can happen in earlier versions of Moodle).
 520          $userids = array_filter($userids, function($userid) use ($members) {
 521              return isset($members[$userid]);
 522          });
 523  
 524          // Return member information in the same order as the userids originally provided.
 525          $members = array_replace(array_flip($userids), $members);
 526  
 527          return $members;
 528      }
 529      /**
 530       * @deprecated since 3.6
 531       */
 532      public static function get_conversations_legacy_formatter() {
 533          throw new \coding_exception('\core_message\helper::get_conversations_legacy_formatter has been removed.');
 534      }
 535  
 536      /**
 537       * Renders the messaging widget.
 538       *
 539       * @param bool $isdrawer Are we are rendering the drawer or is this on a full page?
 540       * @param int|null $sendtouser The ID of the user we want to send a message to
 541       * @param int|null $conversationid The ID of the conversation we want to load
 542       * @param string|null $view The first view to load in the message widget
 543       * @return string The HTML.
 544       */
 545      public static function render_messaging_widget(
 546          bool $isdrawer,
 547          int $sendtouser = null,
 548          int $conversationid = null,
 549          string $view = null
 550      ) {
 551          global $USER, $CFG, $PAGE;
 552  
 553          // Early bail out conditions.
 554          if (empty($CFG->messaging) || !isloggedin() || isguestuser() || user_not_fully_set_up($USER) ||
 555              get_user_preferences('auth_forcepasswordchange') ||
 556              (!$USER->policyagreed && !is_siteadmin() &&
 557                  ($manager = new \core_privacy\local\sitepolicy\manager()) && $manager->is_defined())) {
 558              return '';
 559          }
 560  
 561          $renderer = $PAGE->get_renderer('core');
 562          $requestcount = \core_message\api::get_received_contact_requests_count($USER->id);
 563          $contactscount = \core_message\api::count_contacts($USER->id);
 564  
 565          $choices = [];
 566          $choices[] = [
 567              'value' => \core_message\api::MESSAGE_PRIVACY_ONLYCONTACTS,
 568              'text' => get_string('contactableprivacy_onlycontacts', 'message')
 569          ];
 570          $choices[] = [
 571              'value' => \core_message\api::MESSAGE_PRIVACY_COURSEMEMBER,
 572              'text' => get_string('contactableprivacy_coursemember', 'message')
 573          ];
 574          if (!empty($CFG->messagingallusers)) {
 575              // Add the MESSAGE_PRIVACY_SITE option when site-wide messaging between users is enabled.
 576              $choices[] = [
 577                  'value' => \core_message\api::MESSAGE_PRIVACY_SITE,
 578                  'text' => get_string('contactableprivacy_site', 'message')
 579              ];
 580          }
 581  
 582          // Enter to send.
 583          $entertosend = get_user_preferences('message_entertosend', $CFG->messagingdefaultpressenter, $USER);
 584  
 585          $notification = '';
 586          if (!get_user_preferences('core_message_migrate_data', false)) {
 587              $notification = get_string('messagingdatahasnotbeenmigrated', 'message');
 588          }
 589  
 590          if ($isdrawer) {
 591              $template = 'core_message/message_drawer';
 592              $messageurl = new \moodle_url('/message/index.php');
 593          } else {
 594              $template = 'core_message/message_index';
 595              $messageurl = null;
 596          }
 597  
 598          $templatecontext = [
 599              'contactrequestcount' => $requestcount,
 600              'loggedinuser' => [
 601                  'id' => $USER->id,
 602                  'midnight' => usergetmidnight(time())
 603              ],
 604              // The starting timeout value for message polling.
 605              'messagepollmin' => $CFG->messagingminpoll ?? MESSAGE_DEFAULT_MIN_POLL_IN_SECONDS,
 606              // The maximum value that message polling timeout can reach.
 607              'messagepollmax' => $CFG->messagingmaxpoll ?? MESSAGE_DEFAULT_MAX_POLL_IN_SECONDS,
 608              // The timeout to reset back to after the max polling time has been reached.
 609              'messagepollaftermax' => $CFG->messagingtimeoutpoll ?? MESSAGE_DEFAULT_TIMEOUT_POLL_IN_SECONDS,
 610              'contacts' => [
 611                  'sectioncontacts' => [
 612                      'placeholders' => array_fill(0, $contactscount > 50 ? 50 : $contactscount, true)
 613                  ],
 614                  'sectionrequests' => [
 615                      'placeholders' => array_fill(0, $requestcount > 50 ? 50 : $requestcount, true)
 616                  ],
 617              ],
 618              'settings' => [
 619                  'privacy' => $choices,
 620                  'entertosend' => $entertosend
 621              ],
 622              'overview' => [
 623                  'messageurl' => $messageurl,
 624                  'notification' => $notification
 625              ],
 626              'isdrawer' => $isdrawer,
 627              'showemojipicker' => !empty($CFG->allowemojipicker),
 628              'messagemaxlength' => api::MESSAGE_MAX_LENGTH,
 629              'caneditownmessageprofile' => has_capability('moodle/user:editownmessageprofile', \context_system::instance())
 630          ];
 631  
 632          if ($sendtouser || $conversationid) {
 633              $route = [
 634                  'path' => 'view-conversation',
 635                  'params' => $conversationid ? [$conversationid] : [null, 'create', $sendtouser]
 636              ];
 637          } else if ($view === 'contactrequests') {
 638              $route = [
 639                  'path' => 'view-contacts',
 640                  'params' => ['requests']
 641              ];
 642          } else {
 643              $route = null;
 644          }
 645  
 646          $templatecontext['route'] = json_encode($route);
 647  
 648          return $renderer->render_from_template($template, $templatecontext);
 649      }
 650  
 651      /**
 652       * Returns user details for a user, if they are visible to the current user in the message search.
 653       *
 654       * This method checks the visibility of a user specifically for the purpose of inclusion in the message search results.
 655       * Visibility depends on the site-wide messaging setting 'messagingallusers':
 656       * If enabled, visibility depends only on the core notion of visibility; a visible site or course profile.
 657       * If disabled, visibility requires that the user be sharing a course with the searching user, and have a visible profile there.
 658       * The current user is always returned.
 659       *
 660       * @param \stdClass $user
 661       * @return array the array of userdetails, if visible, or an empty array otherwise.
 662       */
 663      public static function search_get_user_details(\stdClass $user) : array {
 664          global $CFG, $USER;
 665          require_once($CFG->dirroot . '/user/lib.php');
 666  
 667          if ($CFG->messagingallusers || $user->id == $USER->id) {
 668              return \user_get_user_details_courses($user) ?? []; // This checks visibility of site and course profiles.
 669          } else {
 670              // Messaging specific: user must share a course with the searching user AND have a visible profile there.
 671              $sharedcourses = enrol_get_shared_courses($USER, $user);
 672              foreach ($sharedcourses as $course) {
 673                  if (user_can_view_profile($user, $course)) {
 674                      $userdetails = user_get_user_details($user, $course);
 675                      if (!is_null($userdetails)) {
 676                          return $userdetails;
 677                      }
 678                  }
 679              }
 680          }
 681          return [];
 682      }
 683  
 684      /**
 685       * Prevent unclosed HTML elements in a message.
 686       *
 687       * @param string $message The html message.
 688       * @param bool $removebody True if we want to remove tag body.
 689       * @return string The html properly structured.
 690       */
 691      public static function prevent_unclosed_html_tags(
 692          string $message,
 693          bool $removebody = false
 694      ) : string {
 695          $html = '';
 696          if (!empty($message)) {
 697              $doc = new DOMDocument();
 698              $olderror = libxml_use_internal_errors(true);
 699              $doc->loadHTML('<?xml version="1.0" encoding="UTF-8" ?>' . $message);
 700              libxml_clear_errors();
 701              libxml_use_internal_errors($olderror);
 702              $html = $doc->getElementsByTagName('body')->item(0)->C14N(false, true);
 703              if ($removebody) {
 704                  // Remove <body> element added in C14N function.
 705                  $html = preg_replace('~<(/?(?:body))[^>]*>\s*~i', '', $html);
 706              }
 707          }
 708  
 709          return $html;
 710      }
 711  }