mod/chat/report.php

   1 <?php  // $Id$
   2
   3 /// This page prints reports and info about chats
   4
   5     require_once('../../config.php');
   6     require_once('lib.php');
   7
   8     $id            = required_param('id', PARAM_INT);
   9     $start         = optional_param('start', 0, PARAM_INT);   // Start of period
  10     $end           = optional_param('end', 0, PARAM_INT);     // End of period
  11     $deletesession = optional_param('deletesession', 0, PARAM_BOOL);
  12     $confirmdelete = optional_param('confirmdelete', 0, PARAM_BOOL);
  13
  14     if (! $cm = get_coursemodule_from_id('chat', $id)) {
  15         error('Course Module ID was incorrect');
  16     }
  17     if (! $chat = get_record('chat', 'id', $cm->instance)) {
  18         error('Course module is incorrect');
  19     }
  20     if (! $course = get_record('course', 'id', $chat->course)) {
  21         error('Course is misconfigured');
  22     }
  23
  24     $context = get_context_instance(CONTEXT_MODULE, $cm->id);
  25     require_login($course->id, false, $cm);
  26
  27     require_capability('mod/chat:readlog', $context);
  28
  29     add_to_log($course->id, 'chat', 'report', "report.php?id=$cm->id", $chat->id, $cm->id);
  30
  31     $strchats         = get_string('modulenameplural', 'chat');
  32     $strchat          = get_string('modulename', 'chat');
  33     $strchatreport    = get_string('chatreport', 'chat');
  34     $strseesession    = get_string('seesession', 'chat');
  35     $strdeletesession = get_string('deletesession', 'chat');
  36
  37     $navlinks = array();
  38
  39 /// Print a session if one has been specified
  40
  41     if ($start and $end and !$confirmdelete) {   // Show a full transcript
  42
  43         $navlinks[] = array('name' => $strchats, 'link' => "index.php?id=$course->id", 'type' => 'activity');
  44         $navlinks[] = array('name' => format_string($chat->name,true), 'link' => "view.php?id=$cm->id", 'type' => 'activityinstance');
  45         $navlinks[] = array('name' => $strchatreport, 'link' => "report.php?id=$cm->id", 'type' => 'title');
  46
  47         $navigation = build_navigation($navlinks);
  48
  49         print_header_simple(format_string($chat->name).": $strchatreport", '', $navigation,
  50                       '', '', true, '', navmenu($course, $cm));
  51
  52     /// Check to see if groups are being used here
  53         $groupmode = groupmode($course, $cm);
  54         $currentgroup = setup_and_print_groups($course, $groupmode, "report.php?id=$cm->id");
  55
  56         if ($currentgroup) {
  57             $groupselect = " AND groupid = '$currentgroup'";
  58         } else {
  59             $groupselect = "";
  60         }
  61
  62         if ($deletesession and has_capability('mod/chat:deletelog', $context)) {
  63             notice_yesno(get_string('deletesessionsure', 'chat'),
  64                          "report.php?id=$cm->id&amp;deletesession=1&amp;confirmdelete=1&amp;start=$start&amp;end=$end&amp;sesskey=$USER->sesskey",
  65                          "report.php?id=$cm->id");
  66         }
  67
  68         if (!$messages = get_records_select('chat_messages', "chatid = $chat->id AND
  69                                                               timestamp >= '$start' AND
  70                                                               timestamp <= '$end' $groupselect", "timestamp ASC")) {
  71             print_heading(get_string('nomessages', 'chat'));
  72
  73         } else {
  74             echo '<p class="boxaligncenter">'.userdate($start).' --> '. userdate($end).'</p>';
  75
  76             print_simple_box_start('center');
  77             foreach ($messages as $message) {  // We are walking FORWARDS through messages
  78                 $formatmessage = chat_format_message($message, $course->id, $USER);
  79                 if (isset($formatmessage->html)) {
  80                     echo $formatmessage->html;
  81                 }
  82             }
  83             print_simple_box_end();
  84         }
  85
  86         if (!$deletesession or !has_capability('mod/chat:deletelog', $context)) {
  87             print_continue("report.php?id=$cm->id");
  88         }
  89
  90         print_footer($course);
  91         exit;
  92     }
  93
  94
  95 /// Print the Sessions display
  96     $navlinks[] = array('name' => $strchats, 'link' => "index.php?id=$course->id", 'type' => 'activity');
  97     $navlinks[] = array('name' => format_string($chat->name,true), 'link' => "view.php?id=$cm->id", 'type' => 'activityinstance');
  98     $navlinks[] = array('name' => $strchatreport, 'link' => '', 'type' => 'title');
  99
 100     $navigation = build_navigation($navlinks);
 101
 102     print_header_simple(format_string($chat->name).": $strchatreport", '', $navigation,
 103                   '', '', true, '', navmenu($course, $cm));
 104
 105     print_heading(format_string($chat->name).': '.get_string('sessions', 'chat'));
 106
 107
 108 /// Check to see if groups are being used here
 109     if ($groupmode = groupmode($course, $cm)) {   // Groups are being used
 110         $currentgroup = setup_and_print_groups($course, $groupmode, "report.php?id=$cm->id");
 111     } else {
 112         $currentgroup = false;
 113     }
 114
 115     if (!empty($currentgroup)) {
 116         $groupselect = " AND groupid = '$currentgroup'";
 117     } else {
 118         $groupselect = "";
 119     }
 120
 121 /// Delete a session if one has been specified
 122
 123     if ($deletesession and has_capability('mod/chat:deletelog', $context) and $confirmdelete and $start and $end and confirm_sesskey()) {
 124         delete_records_select('chat_messages', "chatid = $chat->id AND
 125                                             timestamp >= '$start' AND
 126                                             timestamp <= '$end' $groupselect");
 127         $strdeleted  = get_string('deleted');
 128         notify("$strdeleted: ".userdate($start).' --> '. userdate($end));
 129         unset($deletesession);
 130     }
 131
 132
 133 /// Get the messages
 134
 135     if (empty($messages)) {   /// May have already got them above
 136         if (!$messages = get_records_select('chat_messages', "chatid = '$chat->id' $groupselect", "timestamp DESC")) {
 137             print_heading(get_string('nomessages', 'chat'));
 138             print_footer($course);
 139             exit;
 140         }
 141     }
 142
 143 /// Show all the sessions
 144
 145     $sessiongap = 5 * 60;    // 5 minutes silence means a new session
 146     $sessionend = 0;
 147     $sessionstart   = 0;
 148     $sessionusers = array();
 149     $lasttime   = 0;
 150
 151     $messagesleft = count($messages);
 152
 153     foreach ($messages as $message) {  // We are walking BACKWARDS through the messages
 154
 155         $messagesleft --;              // Countdown
 156
 157         if (!$lasttime) {
 158             $lasttime = $message->timestamp;
 159         }
 160         if (!$sessionend) {
 161             $sessionend = $message->timestamp;
 162         }
 163         if ((($lasttime - $message->timestamp) < $sessiongap) and $messagesleft) {  // Same session
 164             if ($message->userid and !$message->system) {       // Remember user and count messages
 165                 if (empty($sessionusers[$message->userid])) {
 166                     $sessionusers[$message->userid] = 1;
 167                 } else {
 168                     $sessionusers[$message->userid] ++;
 169                 }
 170             }
 171         } else {
 172             $sessionstart = $lasttime;
 173
 174             if ($sessionend - $sessionstart > 60 and count($sessionusers) > 1) {
 175
 176                 echo '<p align="center">'.userdate($sessionstart).' --> '. userdate($sessionend).'</p>';
 177
 178                 print_simple_box_start('center');
 179
 180                 arsort($sessionusers);
 181                 foreach ($sessionusers as $sessionuser => $usermessagecount) {
 182                     if ($user = get_record('user', 'id', $sessionuser)) {
 183                         print_user_picture($user->id, $course->id, $user->picture);
 184                         echo '&nbsp;'.fullname($user, true); // XXX TODO  use capability instead of true
 185                         echo "&nbsp;($usermessagecount)<br />";
 186                     }
 187                 }
 188
 189                 echo '<p align="right">';
 190                 echo "<a href=\"report.php?id=$cm->id&amp;start=$sessionstart&amp;end=$sessionend\">$strseesession</a>";
 191                 if (has_capability('mod/chat:deletelog', $context)) {
 192                     echo "<br /><a href=\"report.php?id=$cm->id&amp;start=$sessionstart&amp;end=$sessionend&amp;deletesession=1\">$strdeletesession</a>";
 193                 }
 194                 echo '</p>';
 195                 print_simple_box_end();
 196             }
 197
 198             $sessionend = $message->timestamp;
 199             $sessionusers = array();
 200             $sessionusers[$message->userid] = 1;
 201         }
 202         $lasttime = $message->timestamp;
 203     }
 204
 205 /// Finish the page
 206     print_footer($course);
 207
 208 ?>