mod/chat/locallib.php

   1 <?php
   2
   3 // This file is part of Moodle - http://moodle.org/
   4 //
   5 // Moodle is free software: you can redistribute it and/or modify
   6 // it under the terms of the GNU General Public License as published by
   7 // the Free Software Foundation, either version 3 of the License, or
   8 // (at your option) any later version.
   9 //
  10 // Moodle is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 /**
  19  * Library of functions for chat outside of the core api
  20  */
  21
  22 require_once($CFG->dirroot . '/mod/chat/lib.php');
  23 require_once($CFG->libdir . '/portfolio/caller.php');
  24
  25 /**
  26  * @package   mod-chat
  27  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
  28  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  29  */
  30 class chat_portfolio_caller extends portfolio_module_caller_base {
  31     /** @var object */
  32     private $chat;
  33     /** @var int Timestamp */
  34     protected $start;
  35     /** @var int Timestamp */
  36     protected $end;
  37     /**
  38      * @return array
  39      */
  40     public static function expected_callbackargs() {
  41         return array(
  42             'id'    => true,
  43             'start' => false,
  44             'end'   => false,
  45         );
  46     }
  47     /**
  48      * @global object
  49      */
  50     public function load_data() {
  51         global $DB;
  52
  53         if (!$this->cm = get_coursemodule_from_id('chat', $this->id)) {
  54             throw new portfolio_caller_exception('invalidid', 'chat');
  55         }
  56         $this->chat = $DB->get_record('chat', array('id' => $this->cm->instance));
  57         $select = 'chatid = ?';
  58         $params = array($this->chat->id);
  59         if ($this->start && $this->end) {
  60             $select .= ' AND timestamp >= ? AND timestamp <= ?';
  61             $params[] = $this->start;
  62             $params[] = $this->end;
  63         }
  64         $this->messages = $DB->get_records_select(
  65                 'chat_messages',
  66                 $select,
  67                 $params,
  68                 'timestamp ASC'
  69             );
  70         $select .= ' AND userid = ?';
  71         $params[] = $this->user->id;
  72         $this->participated = $DB->record_exists_select(
  73             'chat_messages',
  74             $select,
  75             $params
  76         );
  77     }
  78     /**
  79      * @return array
  80      */
  81     public static function base_supported_formats() {
  82         return array(PORTFOLIO_FORMAT_PLAINHTML);
  83     }
  84     /**
  85      *
  86      */
  87     public function expected_time() {
  88         return portfolio_expected_time_db(count($this->messages));
  89     }
  90     /**
  91      * @return string
  92      */
  93     public function get_sha1() {
  94         $str = '';
  95         ksort($this->messages);
  96         foreach ($this->messages as $m) {
  97             $str .= implode('', (array)$m);
  98         }
  99         return sha1($str);
 100     }
 101
 102     /**
 103      * @return bool
 104      */
 105     public function check_permissions() {
 106         $context = get_context_instance(CONTEXT_MODULE, $this->cm->id);
 107         return has_capability('mod/chat:exportsession', $context)
 108             || ($this->participated
 109                 && has_capability('mod/chat:exportparticipatedsession', $context));
 110     }
 111
 112     /**
 113      * @todo Document this function
 114      */
 115     public function prepare_package() {
 116         $content = '';
 117         $lasttime = 0;
 118         $sessiongap = 5 * 60;    // 5 minutes silence means a new session
 119         foreach ($this->messages as $message) {  // We are walking FORWARDS through messages
 120             $m = clone $message; // grrrrrr - this causes the sha1 to change as chat_format_message changes what it's passed.
 121             $formatmessage = chat_format_message($m, $this->cm->course, $this->user);
 122             if (!isset($formatmessage->html)) {
 123                 continue;
 124             }
 125             if (empty($lasttime) || (($message->timestamp - $lasttime) > $sessiongap)) {
 126                 $content .= '<hr />';
 127                 $content .= userdate($message->timestamp);
 128             }
 129             $content .= $formatmessage->html;
 130             $lasttime = $message->timestamp;
 131         }
 132         $content = preg_replace('/\<img[^>]*\>/', '', $content);
 133
 134         $this->exporter->write_new_file($content, clean_filename($this->cm->name . '-session.html'), false);
 135     }
 136
 137     /**
 138      * @return string
 139      */
 140     public static function display_name() {
 141         return get_string('modulename', 'chat');
 142     }
 143
 144     /**
 145      * @global object
 146      * @return string
 147      */
 148     public function get_return_url() {
 149         global $CFG;
 150
 151         return $CFG->wwwroot . '/mod/chat/report.php?id='
 152             . $this->cm->id . ((isset($this->start))
 153                 ? '&start=' . $this->start . '&end=' . $this->end
 154                 : '');
 155     }
 156 }